Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table plus


DescriptionDetails

Common

Some common fields are handled with specific CLI parameters

CLI FieldPOST FieldDiscussion
planplanKeyLeave blank to add linked (global) repositories.
repositoryKeyselectedRepositoryRequired for add. We have defined some common aliases (case insensitive):

BITBUCKET, CVS, GIT, GITHUB, MERCURIAL, PERFORCE, STASH, SUBVERSION

On 5.6 and higher, there is also BITBUCKET_SERVER which is the same as STASH

repository (or name)repositoryNameRequired for add.
credentialsvaries

New for CLI 7.1 to allow shared credentials to be referenced and their respective fields automatically handled.

Supports GitMercurial, and Bitbucket Cloud repositories.

We strongly recommend using to avoid hassles with setting and maintaining authentication.


Mercurial


POST Field

Example POST Value

Discussion
selectedRepository

com.atlassian.bamboo.plugins.atlassian-bamboo-plugin-mercurial:bb

com.atlassian.bamboo.plugins.atlassian-bamboo-plugin-mercurial:hg

Use as repository key or use one of the aliases.

repository.bitbucket.repositorybob_swift/cliSelected repository when using BitBucket.
repository.bitbucket.usernamebob_swift

repository.bitbucket.temporary.password

***

repository.bitbucket.password.change

trueRegister the password setting.
repository.hg.repositoryUrlhttp://xxx:8001/cli/Repository URL when using Mercurial.
repository.hg.authenticationPASSWORDOthers are SSH_PROXY, KEYFILE.
repository.hg.usernamebob_swift
repository.hg.password***
repository.hg.branch219
repository.hg.commandTimeout180A valid integer value is required. Use -1 for unlimited.
repository.common.quietPeriod.enabledtrueDefaults to false.

selectedWebRepositoryViewer

bamboo.webrepositoryviewer.provided:noRepositoryViewer

A valid value is required for Bamboo releases < 5.5.
...
There are lots of other fields. Look up the name when needed.


Code Block
-a addRepository --name cli-bitbucket --repositoryKey MERCURIAL --credentials bitbucket-cloud --field1 repository.hg.repositoryUrl --value1 https://xxx:8001/cli


Code Block
-a addRepository --name cli-bitbucket --repositoryKey BITBUCKET --field1 repository.bitbucket.repository --value1 bob_swift/cli --field2 repository.bitbucket.username --value2 bob_swift --field3 repository.bitbucket.temporary.password *** --field4 selectedWebRepositoryViewer --value4 bamboo.webrepositoryviewer.provided:noRepositoryViewer --field5 repository.bitbucket.commandTimeout --value5 180 --field6 repository.bitbucket.password.change --value6 true


Code Block
-a addRepository --plan XX-XX --name cli --repositoryKey MERCURIAL --fields "repository.hg.repositoryUrl:http://xxx:8001/cli,repository.hg.authentication:PASSWORD,repository.hg.username:,repository.hg.password:,repository.hg.branch:default,repository.hg.commandTimeout:180,selectedWebRepositoryViewer:bamboo.webrepositoryviewer.provided:noRepositoryViewer"


Code Block
-a addRepository --plan XX-XX --name cli-anonymous --repositoryKey MERCURIAL --field1 repository.hg.repositoryUrl --value1 http://xxx:8001/cli --field2 repository.hg.authentication --value2 PASSWORD


GIT


POST Field

Example POST Value

Discussion
selectedRepository

com.atlassian.bamboo.plugins.atlassian-bamboo-plugin-git:git

Use as repository key or use one of the aliases.

repository.bitbucket.repositorybob_swift/git-exampleSelected repository when using BitBucket.

repository.git.repositoryUrl

<direct url to git repository>Alternative if not accessing GIT via Bitbucket name.

repository.bitbucket.authenticationType

PASSWORD or SHARED_CREDENTIALSNeeded on Bitbucket 5.14 and higher at least
repository.bitbucket.usernamebob_swiftOmit if repository allows anonymous access.

repository.bitbucket.temporary.password

***Omit if repository allows anonymous access.

repository.bitbucket.password.change

trueRegister the password setting.

repository.bitbucket.scm

GITRepository type.

repository.bitbucket.branch

masterBranch.
repository.bitbucket.commandTimeout180A valid integer value is required. Use -1 for unlimited.
repository.common.quietPeriod.enabledtrueDefaults to false.

selectedWebRepositoryViewer

bamboo.webrepositoryviewer.provided:noRepositoryViewer

A valid value is required for Bamboo releases < 5.5.


Code Block
-a addRepository --name cli-bitbucket --repositoryKey BITBUCKET --credentials bitbucket-cloud --field1 repository.bitbucket.repository --value1 bob_swift/cli --fields repository.bitbucket.branch:master,repository.bitbucket.git.useShallowClones:true"


Code Block
-a addRepository --name git-example --repositoryKey BITBUCKET --field1 repository.bitbucket.repository --value1 bob_swift/git-example --field2 repository.bitbucket.username --value2 bob_swift --field3 repository.bitbucket.temporary.password --value3 "***" --field4 selectedWebRepositoryViewer --value4 bamboo.webrepositoryviewer.provided:noRepositoryViewer --field5 repository.bitbucket.commandTimeout --value5 180 --field6 repository.bitbucket.password.change --value6 true --fields repository.bitbucket.scm:GIT,repository.bitbucket.branch:master,repository.bitbucket.authenticationType:PASSWORD


Bitbucket Cloud


Div


POST FieldExample POST ValueDiscussion
selectedRepository

com.atlassian.bamboo.plugins.stash.atlassian-bamboo-plugin-bitbucket:bb 

Use as repository key or use one of the aliases - BITBUCKET or BITBUCKET_CLOUD

repository.bitbucket.repositorycli

repository.bitbucket.branch

masterBranch. Defaults to master, but recommend setting explicitly to make it obvious.
repository.bitbucket.usernameautomation
repository.bitbucket.temporary.password***
repository.bitbucket.password.changetrue
repository.bitbucket.commandTimeout180A valid integer value is required. Use -1 for unlimited.
repository.common.quietPeriod.enabledtrueDefaults to false.


Code Block
-a addRepository --name bitbucket-example --repositoryKey BITBUCKET_CLOUD --field1 name --value1 example --field2 repository.bitbucket.username --value2 automation --field3 repository.bitbucket.temporary.password --value3 *** --field5 branch --value5 master --fields repository.bitbucket.commandTimeout:0 



Bitbucket Server

(formerly Stash)


Div


POST FieldExample POST ValueDiscussion
selectedRepository

com.atlassian.bamboo.plugins.stash.atlassian-bamboo-plugin-stash:stash-rep 

Use as repository key or use one of the aliases - BITBUCKET_SERVER or STASH

repository.stash.projectKeyCLIStash project key
repository.stash.repositoryId112Numeric repository id. For instance, use getRepositoryList from Stash CLI to find the id.
repository.stash.repositorySlugcli

repository.stash.repositoryUrl

ssh://git@examplegear.com:7999/cli/cli.git
This was required, but, it accepted any non-blank value. Do not know if this is actually used by Bamboo.
repository.stash.server

42949fec-6f88-3cd8-b146-a1189f8dab5

Application link id to your Stash server. Use the browser source or Inspect Element support on the list of Configure Application Links screen.

repository.stash.branch

masterBranch. Defaults to master, but recommend setting explicitly to make it obvious.
repository.stash.commandTimeout180A valid integer value is required. Use -1 for unlimited.
repository.common.quietPeriod.enabledtrueDefaults to false.

selectedWebRepositoryViewer

bamboo.webrepositoryviewer.provided:noRepositoryViewer

A valid value is required for Bamboo releases < 5.5. Otherwise let it default.


Code Block
-a addRepository --name stashbitbucket-example --repositoryKey STASHBITBUCKET_SERVER --field1 repository.stash.projectKey --value1 CLI --field2 repository.stash.repositoryId --value2 112 --field3 repository.stash.repositorySlug --value3 cli --field4 repository.stash.server --value4 42949fec-6f88-3cd8-b146-a1189f8dab5b --field5 branch --value5 master --field6 repository.stash.repositoryUrl --value6 ssh://git@examplegear.com:7999/cli/cli.git --fields repository.stash.commandTimeout:0 




...