Update

Learn how to modify a repo.

Command

$ vela update repo <parameters...> <arguments...>

For more information, you can run vela update repo --help.

Parameters

The following parameters are used to configure the command:

Name	Description	Environment Variables
`org`	name of organization for the repository	`VELA_ORG`, `REPO_ORG`
`repo`	name of repository	`VELA_REPO`, `REPO_NAME`
`branch`	default branch for the repository	`VELA_BRANCH`, `REPO_BRANCH`
`link`	full URL for the repository	`VELA_LINK`, `REPO_LINK`
`clone`	clone URL for the repository	`VELA_CLONE`, `REPO_CLONE`
`visibility`	access level required to view the repository	`VELA_VISIBILITY`, `REPO_VISIBILITY`
`build.limit`	limit of concurrent builds allowed for repository	`VELA_BUILD_LIMIT`, `REPO_BUILD_LIMIT`
`timeout`	max time allowed per build	`VELA_TIMEOUT`, `REPO_TIMEOUT`
`counter`	set a value for a new build number	`VELA_COUNTER`, `REPO_COUNTER`
`private`	disables public access to the repository	`VELA_PRIVATE`, `REPO_PRIVATE`
`trusted`	elevates permissions for builds for the repository	`VELA_TRUSTED`, `REPO_TRUSTED`
`active`	enables/disables the repository	`VELA_ACTIVE`, `REPO_ACTIVE`
`event`	events to trigger builds for the repository	`VELA_EVENTS`, `REPO_EVENTS`
`pipeline-type`	type of base pipeline for the compiler to render	`VELA_PIPELINE_TYPE`, `PIPELINE_TYPE`
`output`	format the output for the repository	`VELA_OUTPUT`, `REPO_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.

As of Vela v0.23.0, the event flag is an overwrite/clobber operation.

$ vela update repo --org github --repo octocat --event tag

The above will set the allowed events to only tag. Be sure to specify all events when updating a repo via the CLI.

Permissions

COMING SOON!

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 update repo --event tag

Targeted Request

$ vela update repo --org github --repo octocat --event tag

Response

id: 1
userid: 1
org: github
name: octocat
fullname: github/octocat
link: https://github.com/github/octocat
clone: https://github.com/github/octocat.git
branch: main
buildlimit: 10
timeout: 60
counter: 0
visibility: public
private: false
trusted: false
active: true
allowpull: true
allowpush: true
allowdeploy: false
allowtag: true
allowcomment: false
allowevents: [tag]
pipelinetype: yaml

Last modified February 12, 2024: docs(repos): add allow_events remodel documentation (#394) (2d3e3a6a)