Skip to main content
Version: Current 🚧

Add

Command​

$ vela add repo <parameters...> <arguments...>
info

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

Parameters​

The following parameters are used to configure the command:

NameDescriptionEnvironment Variables
orgname of organization for the repositoryVELA_ORG, REPO_ORG
reponame of repositoryVELA_REPO, REPO_NAME
branchdefault branch for the repositoryVELA_BRANCH, REPO_BRANCH
linkfull URL for the repositoryVELA_LINK, REPO_LINK
cloneclone URL for the repositoryVELA_CLONE, REPO_CLONE
visibilityaccess level required to view the repositoryVELA_VISIBILITY, REPO_VISIBILITY
build.limitlimit of concurrent builds allowed for repositoryVELA_BUILD_LIMIT, REPO_BUILD_LIMIT
timeoutmax time allowed per buildVELA_TIMEOUT, REPO_TIMEOUT
counterset a value for a new build numberVELA_COUNTER, REPO_COUNTER
privatedisables public access to the repositoryVELA_PRIVATE, REPO_PRIVATE
trustedelevates permissions for builds for the repositoryVELA_TRUSTED, REPO_TRUSTED
activeenables/disables the repositoryVELA_ACTIVE, REPO_ACTIVE
eventevents to trigger builds for the repositoryVELA_EVENTS, REPO_EVENTS
pipeline-typetype of base pipeline for the compiler to renderVELA_PIPELINE_TYPE, PIPELINE_TYPE
outputformat the output for the repositoryVELA_OUTPUT, REPO_OUTPUT
info

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​

info

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 add repo

Targeted Request​

$ vela add repo --org github --repo octocat

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
timeout: 0
visibility: public
private: false
trusted: false
active: true
allowpull: true
allowpush: true
allowdeploy: false
allowtag: false
allowcomment: false
allowevents: [push pull_request:opened pull_request:synchronize ]
pipelinetype: yaml