Gitlab Merge Request

“assignees” contains the list of assignee to add to the merge request

default: empty

remark: assignees only accept GitLab User IDs. To find the user ID: 1. Go to the users’ profile page. 2. On the profile page, in the upper-right corner, select Actions (or ⋮). 3. Select Copy user ID.

“body” defines a custom mergerequest body

default: By default a mergerequest body is generated out of a pipeline execution.

remark: Unless you know what you are doing, you shouldn’t set this value and rely on the sane default. “body” is useful to provide additional information when reviewing mergerequest, such as changelog url.

“labels” defines labels for the merge request.

default: empty

remark:
	if a label does not already exist, this creates a new project label and assigns it to the merge request

“owner” defines the GitLab repository owner.

remark: unless you know what you are doing, you shouldn’t set this value and rely on the scmid to provide the sane default.

“removesourcebranch” is a flag indicating if a merge request should remove the source branch when merging

default: false

“repository” defines the GitLab repository for a specific owner

remark: unless you know what you are doing, you shouldn’t set this value and rely on the scmid to provide the sane default.

“reviewers” contains the list of reviewers to add to the merge request

default: empty

remark: assignees only accept GitLab User IDs. To find the user ID: 1. Go to the users’ profile page. 2. On the profile page, in the upper-right corner, select Actions (or ⋮). 3. Select Copy user ID.

“sourcebranch” defines the branch name used as a source to create the GitLab mergerequest.

default: “sourcebranch” inherits the value from the scm branch if a scm of kind “gitlab” is specified by the action.

remark: unless you know what you are doing, you shouldn’t set this value and rely on the scmid to provide the sane default.

“squash” defines if all commits should be squashed into a single commit on merge

default: false

remark: project settings might override this value

“targetbranch” defines the branch name used as a target to create the GitLab mergerequest.

default: “targetbranch” inherits the value from the scm working branch if a scm of kind “gitlab” is specified by the action.

remark: unless you know what you are doing, you shouldn’t set this value and rely on the scmid to provide the sane default. the GitLab scm will create and use a working branch such as updatecli_xxxx

“title” defines the GitLab mergerequest title

default: A GitLab mergerequest title is defined by one of the following location (first match) 1. title is defined by the spec such as:

 			actions:
 				default:
 					kind: gitlab/mergerequest
 					scmid: default
 					spec:
 						title: This is my awesome title

 		2. title is defined by the action such as:

 			actions:
 				default:
 					kind: gitlab/mergerequest
 					scmid default
 					title: This is my awesome title

 		3. title is defined by the first associated target title

 		4. title is defined by the pipeline title

remark: usually we prefer to go with option 2

“token” defines the credential used to authenticate with GitLab

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 "GITLAB_TOKEN"}} to retrieve the token from the environment variable GITLAB_TOKEN or {{ .gitlab.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

“tokentype” defines type of provided token. Valid values are “private” and “bearer”

default: “private”

“url” defines the GitLab url to interact with

default: “gitlab.com”