GitLab Release

“age” defines the minimum or maximum age of a release to be considered valid.

compatible:

• source

remark:

• it accepts a duration string such as “24h”, “7d”, “3w” or “1y”.
• the age of a release is its release date, or its creation date for a release published without one.
• when no release matches the age filter yet, the source is skipped instead of failing.

“maximum” defines the maximum age a release may have to be considered.

remark:

• accepted units are “d” for days, “w” for weeks, “mo” for months and “y” for years, plus the Go duration units such as “h”, “m” and “s”.
• a unit is required.
• a month counts as 1/12 of a year and a year as 365 days.

example:

• maximum: 6mo
• maximum: 1y

“minimum” defines the minimum age a release must have to be considered.

remark:

• accepted units are “d” for days, “w” for weeks, “mo” for months and “y” for years, plus the Go duration units such as “h”, “m” and “s”.
• a unit is required.
• a month counts as 1/12 of a year and a year as 365 days.

example:

• minimum: 24h
• minimum: 7d
• minimum: 3w

“commitish” defines the commit-ish of the GitLab release, such as a branch name or a commit sha.

compatible:

• target

default: main

example:

• commitish: main

“description” defines the description of the new GitLab release.

compatible:

• target

remark:

• Updatecli appends a credit line to the description.

“draft” defines if the release is a draft release.

compatible:

• target

default: false

“owner” defines the owner of the GitLab repository.

compatible:

• source
• condition
• target

example:

• owner: updatecli

“prerelease” defines if the release is a pre-release.

compatible:

• target

default: false

“repository” defines the name of the GitLab repository, for a specific owner.

compatible:

• source
• condition
• target

example:

• repository: updatecli

“tag” defines the tag of the GitLab release.

compatible:

• condition
• target

default: the output of the associated source.

example:

• tag: v1.0.0

“title” defines the title of the GitLab release.

compatible:

• target

default: the value of “tag”.

“token” defines the credential used to authenticate with GitLab.

remark:

• a token is sensitive information. Do not set it directly in the manifest, use an environment variable or a SOPS file instead.
• {{ requiredEnv "GITLAB_TOKEN" }} retrieves the token from the environment variable GITLAB_TOKEN.
• {{ .gitlab.token }} retrieves the token from a SOPS file.
• for more information about SOPS files, see https://github.com/getsops/sops

example:

• token: ‘{{ requiredEnv “GITLAB_TOKEN” }}’

“url” defines the GitLab url to interact with.

default: gitlab.com

remark:

• “https://” is added when the url has no “http://” or “https://” scheme.

example:

• url: gitlab.com
• url: https://gitlab.example.com

“versionfilter” defines the version pattern and kind used to select the release, such as regex, semver or latest.

compatible:

• source

default: kind: latest

“kind” defines the versioning scheme used to select a version.

default: latest

remark:

• accepted values are “latest”, “semver”, “regex”, “regex/semver”, “time”, “regex/time”, “lex” and “pep440”.
• “latest” returns the last version of the list.
• “lex” sorts the versions lexicographically and returns the last one.
• “pep440” follows https://peps.python.org/pep-0440/

example:

• kind: semver

“pattern” defines the version pattern, according to “kind”.

default:

• latest: “latest”
• semver and pep440: “*”
• regex: “.*”
• time and regex/time: “2006-01-02”

remark:

• for “latest”, “latest” returns the last version, any other value must match a version exactly.
• for “semver” and “regex/semver”, it is a semantic versioning constraint.
• for “pep440”, it is a pep440 version specifier.
• for “regex”, it is a regular expression.
• for “time” and “regex/time”, it is a Go date layout.
• ignored by “lex”.

example:

• pattern: ~1.2
• pattern: “>=1.0.0 <2.0.0”
• pattern: ^v\d+.\d+.\d+$

“regex” defines the regular expression extracting the version from each entry.

remark:

• only used by the kinds “regex/semver” and “regex/time”.
• the value of the first capture group is used as the version.

example:

• regex: ^v(\d+.\d+.\d+)$

“replaceall” applies a regular expression replacement to each version before filtering.

remark:

• only used by the kinds “regex”, “regex/semver” and “regex/time”.
• the replacement runs before “pattern” or “regex” is evaluated.

example:

replaceall:
  pattern: "_"
  replacement: "."

turns “curl-8_15_0” into “curl-8.15.0”.

“strict” enforces strict semantic versioning rules when parsing versions.

default: false

remark:

• only used by the kinds “semver” and “regex/semver”.