Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

vela: add page #4942

Merged
merged 12 commits into from
Nov 16, 2020
Merged

vela: add page #4942

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
c89b6a3
Create vela.md
CrystalSpore Nov 6, 2020
91fe8bb
Update vela.md
CrystalSpore Nov 6, 2020
b6a4089
Update vela.md
CrystalSpore Nov 6, 2020
5cb298b
change Vela to uppercase
CrystalSpore Nov 6, 2020
5199212
update variables to snake_case
CrystalSpore Nov 6, 2020
17046d9
Change "more information" link to specific cli docs
CrystalSpore Nov 9, 2020
1abe458
update target & ref options
CrystalSpore Nov 9, 2020
82fb733
Add 'get deployment' & 'view deployment' examples
CrystalSpore Nov 9, 2020
816553a
Improve wording on `vela get deployment` description
CrystalSpore Nov 10, 2020
2583b26
switch from commas to pipes for separating options
CrystalSpore Nov 10, 2020
78bc1cf
Modify description to say what references can be used to run pipeline
CrystalSpore Nov 10, 2020
fe8c698
Improve wording for command description
CrystalSpore Nov 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions pages/common/vela.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# vela

> Command line tools for the Vela pipeline.
> More information: <https://go-vela.github.io/docs/cli/>.

- Trigger a pipeline to run from a git branch, commit or tag:

`vela add deployment --org {{organization}} --repo {{repository_name}} --target {{environment}} --ref {{branch|commit|refs/tags/git_tag}} --description "{{deploy_description}}"`

- List deployments for a repository:

`vela get deployment --org {{organization}} --repo {{repository_name}}`

- Inspect a specific deployment:

`vela view deployment --org {{organization}} --repo {{repository_name}} --deployment {{deployment_number}}`