Bitbucket Server (Stash)

“branch” defines the git branch to work on.

compatible:

• scm

default: main

remark: depending on which resource references the Stash scm, the behavior will be different.

If the scm is linked to a source or a condition (using scmid), the branch will be used to retrieve file(s) from that branch.

If the scm is linked to target then Updatecli creates a new “working branch” based on the branch value. The working branch created by Updatecli looks like “updatecli_”. The working branch can be disabled using the “workingBranch” parameter set to false.

“commitMessage” is used to generate the final commit message.

compatible:

• scm

remark: it’s worth mentioning that the commit message settings is applied to all targets linked to the same scm.

“body” defines the commit body of the commit message as defined by the conventional commit specification. More information on -> https://www.conventionalcommits.org/en/

	default:
		none

footers defines the footer of the commit message as defined by the conventional commit specification. More information on -> https://www.conventionalcommits.org/en/

	default:
		none

“hideCredit” defines if updatecli credits should be displayed inside commit message body

	please consider sponsoring the Updatecli project if you want to disable credits.
	-> https://github.com/updatecli/updatecli

	default:
		false

“scope” defines the scope of the commit message as defined by the conventional commit specification. More information on -> https://www.conventionalcommits.org/en/

	default:
		none

“title” defines the title of the commit message as defined by the conventional commit specification. More information on -> https://www.conventionalcommits.org/en/

	default:
		default is set to the target name or the target short description
		if the name is not defined.

“type” defines the type of commit message such as “chore”, “fix”, “feat”, etc. as defined by the conventional commit specification. More information on -> https://www.conventionalcommits.org/en/

	default:
		* chore

“directory” defines the local path where the git repository is cloned.

compatible:

• scm

remark: Unless you know what you are doing, it is recommended to use the default value. The reason is that Updatecli may automatically clean up the directory after a pipeline execution.

default: The default value is based on your local temporary directory like: (on Linux) /tmp/updatecli/stash//

“email” defines the email used to commit changes.

compatible:

• scm

default: default set to your global git configuration

“force” is used during the git push phase to run git push --force.

compatible:

• scm

default: false

remark: When force is set to true, Updatecli also recreate the working branches that diverged from their base branch.

“gpg” specifies the GPG key and passphrased used for commit signing

compatible:
	* scm

signingKey defines the gpg key used to sign the commit message

	default:
		none

“owner” defines the owner of a repository.

compatible:
	* scm

“password” specifies the credential used to authenticate with Bitbucket Server API, it must be combined with “username”

remark: A token is a sensitive information, it’s recommended to not set this value directly in the configuration file but to use an environment variable or a SOPS file.

The value can be set to {{ requiredEnv "BITBUCKET_TOKEN"}} to retrieve the token from the environment variable BITBUCKET_TOKEN or {{ .bitbucket.token }} to retrieve the token from a SOPS file.

  For more information, about a SOPS file, please refer to the following documentation:

https://github.com/getsops/sops

repository specifies the name of a repository for a specific owner.

compatible:
	* scm

“submodules” defines if Updatecli should checkout submodules.

compatible: * scm

default: true

“token” specifies the credential used to authenticate with Bitbucket Server API

remark: A token is a sensitive information, it’s recommended to not set this value directly in the configuration file but to use an environment variable or a SOPS file.

The value can be set to {{ requiredEnv "BITBUCKET_TOKEN"}} to retrieve the token from the environment variable BITBUCKET_TOKEN or {{ .bitbucket.token }} to retrieve the token from a SOPS file.

  For more information, about a SOPS file, please refer to the following documentation:

https://github.com/getsops/sops

“user” specifies the user associated with new git commit messages created by Updatecli

compatible:
	* scm

“workingBranch” defines if Updatecli should use a temporary branch to work on. If set to true, Updatecli create a temporary branch to work on, based on the branch value.

compatible: * scm

default: true