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

“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:
		/tmp/updatecli/<url>

“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

“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

“url” specifies the git url

	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