Gitlab
Gitlab scm
On this page
Description
The Gitlab scm plugin is used to manage git repositories hosted on Gitlab, depending on the stage, it can be used for different purposes
source: Retrieve data from a git repository, such as a file content condition: Ensure data exist on a git repository, such as a file content target: Ensure data is up to date on a git repository
Parameters
Name | Type | Description | Required |
---|---|---|---|
branch | string | “branch” defines the git branch to work on.
| |
commitmessage | object | “commitMessage” is used to generate the final commit message.
| |
body | string | “body” defines the commit body of the commit message as defined by the conventional commit specification. More information on -> https://www.conventionalcommits.org/en/
| |
footers | string | footers defines the footer of the commit message as defined by the conventional commit specification. More information on -> https://www.conventionalcommits.org/en/
| |
hidecredit | boolean | “hideCredit” defines if updatecli credits should be displayed inside commit message body
| |
scope | string | “scope” defines the scope of the commit message as defined by the conventional commit specification. More information on -> https://www.conventionalcommits.org/en/
| |
title | string | “title” defines the title of the commit message as defined by the conventional commit specification. More information on -> https://www.conventionalcommits.org/en/
| |
type | string | “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/
| |
directory | string | “directory” defines the local path where the git repository is cloned.
| |
string | “email” defines the email used to commit changes.
| ||
force | boolean | “force” is used during the git push phase to run
| |
gpg | object | “gpg” specifies the GPG key and passphrased used for commit signing
| |
passphrase | string | passphrase defines the gpg passphrase used to sign the commit message | |
signingkey | string | signingKey defines the gpg key used to sign the commit message
| |
owner | string | “owner” defines the owner of a repository.
| |
repository | string | repository specifies the name of a repository for a specific owner.
| |
token | string | “token” defines the credential used to authenticate with GitLab | |
url | string | “url” defines the GitLab url to interact with
| |
user | string | “user” specifies the user associated with new git commit messages created by Updatecli
| |
username | string | “username” defines the username used to authenticate with GitLab |
CommitMessage
Updatecli uses conventional commits as describe on www.conventionnalcommits.org.
The goal is to add human and machine readable meaning to commit messages
By default, Updatecli generates a commit message using the default type "chore" and split long title message into the body like:
Author: olblak <updatecli@updatecli.io>
Date: Tue May 4 15:41:44 2021 +0200
chore: Update key "dependencies[0].version" from file "charts/jenkins/r...
... equirements.yaml"
Made with ❤️️ by updatecli
Name | Required | Default | Description |
---|---|---|---|
type | chore | Specify commit type | |
scope | Specify commit scope | ||
footer | Specify commit footer message | ||
title | Override default body message | ||
hideCredit | Remove "Made with ❤️️ by updatecli" from commit message | ||
body | Override default body message |
GPG
Updatecli can sign commits using a private GPG key if configured accordingly.
Name | Required | Default | Description |
---|---|---|---|
signingkey | Defines the armored private gpg key | ||
password | Defines the gpg key password |
Example
# updatecli.yaml
---
name: Show Gitlab scm
scms:
gitlab:
kind: gitlab
spec:
# By default url is set to gitlab.com
# url: gitlab.com
owner: "olblak"
repository: "updatecli"
branch: main
sources:
license:
name: Retrieve license file content
kind: file
scmid: gitlab
spec:
file: LICENSE