Git

“branch” defines the git branch to work on.

compatible:
  * scm

default:
	main

remark:
	depending on which resource references the GitHub 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 will push any changes to that branch

	For more information, please refer to the following issue:
	https://github.com/updatecli/updatecli/issues/1139

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

compatible:
  * scm

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

default:
  false

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

squash defines if the commit should be squashed

default: false

important: if squash is set to true, then it’s highly recommended to set the commit body to a meaningful value as all other commit information will be lost during the squash operation.

if body is not set, then the commit title/message will be generated based on the most recent commit message of the squashed commits. The commit title is always generated from the target name or description.

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

Depth defines the depth used when cloning the git repository.

Default: disabled (full clone)

Remark: When using a shallow clone (depth greater than 0), Updatecli is not able to retrieve the full git history. This may cause some issues when Updatecli tries to push changes to the remote repository. In that case, you may need to set the force option to true to force push changes to the remote repository.

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

compatible:
  * scm

remark:
  Unless you know what you are doing, it is highly 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 /tmp/updatecli/<url> on Linux

“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

“password” specifies the password when using the HTTP protocol

compatible:
  * scm

“submodules” defines if Updatecli should checkout submodules.

compatible: * scm

default: true

“url” specifies the git url to work on.

compatible:
  * scm

example:
  * git@github.com:updatecli/updatecli.git
  * https://github.com/updatecli/updatecli.git

remarks:
	when using the ssh protocol, the user must have the right to clone the repository
	based on its local ssh configuration

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

compatible:
  * scm

“username” specifies the username when using the HTTP protocol

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: false

WorkingBranchPrefix defines the prefix used to create a working branch.

compatible:

• scm

default: updatecli

remark: A working branch is composed of three components:

1. WorkingBranchPrefix
2. Target Branch
3. PipelineID

If WorkingBranchPrefix is set to ‘’, then the working branch will look like “_”.

WorkingBranchSeparator defines the separator used to create a working branch.

compatible:

• scm

default: “_”