View
Learn how to inspect a schedule.
Command
$ vela view schedule <parameters...> <arguments...>
For more information, you can run
vela view schedule --help
.Parameters
The following parameters are used to configure the command:
Name | Description | Environment Variables |
---|---|---|
org | name of organization for the schedule | VELA_ORG , SCHEDULE_ORG |
repo | name of repository for the schedule | VELA_REPO , SCHEDULE_REPO |
schedule | name of the schedule | VELA_SCHEDULE , SCHEDULE_NAME |
output | format the output for the schedule | VELA_OUTPUT , SCHEDULE_OUTPUT |
This command also supports setting the following parameters via a configuration file:
org
repo
output
For more information, please review the CLI config documentation.
Sample
This section assumes you have already installed and setup the CLI.
To install the CLI, please review the installation documentation.
To setup the CLI, please review the authentication documentation.
Request
$ pwd
~/github/octocat
$ vela view schedule --schedule hourly
Targeted Request
$ vela view schedule --org github --repo octocat --schedule hourly --output json
Response
{
"id": 1,
"repo": {
"id": 1,
"owner": {
"id": 1,
"name": "octokitty",
"active": true
},
"org": "github",
"name": "octokitty",
"full_name": "github/octokitty",
"link": "https://github.com/github/octokitty",
"clone": "https://github.com/github/octokitty.git",
"branch": "main",
"topics": [],
"build_limit": 10,
"timeout": 30,
"counter": 0,
"visibility": "public",
"private": false,
"trusted": false,
"active": true,
"allow_events": {
"push": {
"branch": true,
"tag": false,
"delete_branch": false,
"delete_tag": false
},
"pull_request": {
"opened": false,
"edited": false,
"synchronize": false,
"reopened": false,
"labeled": false,
"unlabeled": false
},
"deployment": {
"created": false
},
"comment": {
"created": false,
"edited": false
},
"schedule": {
"run": false
}
},
"pipeline_type": "yaml",
"previous_name": "",
"approve_build": "fork-always"
},
"active": true,
"name": "hourly",
"entry": "0 * * * *",
"created_at": 1716495910,
"created_by": "octokitty",
"updated_at": 1716495910,
"updated_by": "octokitty",
"scheduled_at": 0,
"branch": "main",
"error": "",
"next_run": 1716499800
}
Examples
EXAMPLES:
1. View details of a schedule for a repository.
$ vela view schedule --org MyOrg --repo MyRepo --schedule hourly
2. View details of a schedule for a repository with json output.
$ vela view schedule --org MyOrg --repo MyRepo --schedule hourly --output json
3. View details of a schedule for a repository when config or environment variables are set.
$ vela view schedule
Last modified June 24, 2024: Update Schedule API response examples (#412) (5fc450e3)