Templates
Several fields in Kmdo's config file support templating.
Those fields are often suffixed with _template, but sometimes they may not
be. The documentation of each section should be explicit about which fields
support templating.
Common Fields
In fields that support templates, these fields are always available:
| Key | Description |
|---|---|
.ProjectName | the project name |
.Version | the version being released[^version-prefix] |
.Branch | the current git branch |
.Tag | the current git tag |
.PreviousTag | the previous git tag, or empty if no previous tags |
.ShortCommit | the git commit short hash |
.FullCommit | the git commit full hash |
.Commit | the git commit hash (deprecated) |
.CommitDate | the UTC commit date in RFC 3339 format |
.CommitTimestamp | the UTC commit date in Unix format |
.GitURL | the git remote url |
.GitTreeState | either 'clean' or 'dirty' |
.IsGitClean | whether or not current git state is clean |
.IsGitDirty | whether or not current git state is dirty |
.Major | the major part of the version[^tag-is-semver] |
.Minor | the minor part of the version[^tag-is-semver] |
.Patch | the patch part of the version[^tag-is-semver] |
.Prerelease | the prerelease part of the version, e.g. beta[^tag-is-semver] |
.RawVersion | composed of {Major}.{Minor}.{Patch} [^tag-is-semver] |
.ReleaseNotes | the generated release notes, available after the changelog step has been executed |
.IsDraft | true if release.draft is set in the configuration, false otherwise |
.IsSnapshot | true if --snapshot is set, false otherwise |
.IsNightly | true if --nightly is set, false otherwise |
.IsSingleTarget | true if --single-target is set, false otherwise (since v2.3) |
.Env | a map with system's environment variables |
.Date | current UTC date in RFC 3339 format |
.Now | current UTC date as time.Time struct, allows all time.Time functions (e.g. {{ .Now.Format "2006" }}) |
.Timestamp | current UTC time in Unix format |
.ModulePath | the go module path, as reported by go list -m |
.ReleaseURL | the current release download url[^scm-release-url] |
.Summary | the git summary, e.g. v1.0.0-10-g34f56g3[^git-summary] |
.TagSubject | the annotated tag message subject, or the message subject of the commit it points out[^git-tag-subject] |
.TagContents | the annotated tag message, or the message of the commit it points out[^git-tag-body] |
.TagBody | the annotated tag message's body, or the message's body of the commit it points out[^git-tag-body] |
.Runtime.Goos | equivalent to runtime.GOOS |
.Runtime.Goarch | equivalent to runtime.GOARCH |
.Outputs | custom outputs (since v2.11) |
Single-artifact extra fields
On fields that are related to a single artifact (e.g., the binary name), you may have some extra fields:
| Key | Description |
|---|---|
.Os | GOOS |
.Arch | GOARCH |
.Arm | GOARM |
.Mips | GOMIPS |
.Amd64 | GOAMD64 |
.Arm64 | GOARM64 (since v2.4) |
.Mips64 | GOMIPS64 (since v2.4) |
.Ppc64 | GOPPC64 (since v2.4) |
.Riscv64 | GORISCV64 (since v2.4) |
.I386 | GO386 (since v2.4) |
.Target | the whole target (since v2.5) |
.Binary | artifact name |
.ArtifactName | artifact name |
.ArtifactPath | absolute path to artifact |
.ArtifactExt | artifact extension (e.g. .exe, .dmg, etc) |
nFPM extra fields
In the nFPM name template field, you can use those extra fields:
| Key | Description |
|---|---|
.Release | release from the nfpm config |
.Epoch | epoch from the nfpm config |
.PackageName | package the name. Same as ProjectName if not overridden. |
.ConventionalFileName | conventional package file name as provided by nFPM.[^arm-names] |
.ConventionalExtension | conventional package extension as provided by nFPM |
.Format | package format |
Release body extra fields
In the release.body field, you can use these extra fields:
| Key | Description |
|---|---|
.Checksums | the current checksum file contents, or a map of filename/checksum contents if checksum.split is set. Only available in the release body |
Functions
On all fields, you have these available functions:
| Usage | Description |
|---|---|
replace "v1.2" "v" "" | replaces all matches. See ReplaceAll |
split "1.2" "." | split string at separator. See Split |
time "01/02/2006" | current UTC time in the specified format (this is not deterministic, a new time for every call) |
contains "foobar" "foo" | checks whether the first string contains the second. See Contains |
tolower "V1.2" | makes input string lowercase. See ToLower |
toupper "v1.2" | makes input string uppercase. See ToUpper |
trim " v1.2 " | removes all leading and trailing white space. See TrimSpace |
trimprefix "v1.2" "v" | removes provided leading prefix string, if present. See TrimPrefix |
trimsuffix "1.2v" "v" | removes provided trailing suffix string, if present. See TrimSuffix |
dir .Path | returns all but the last element of path, typically the path's directory. See Dir |
base .Path | returns the last element of path. See Base |
abs .ArtifactPath | returns an absolute representation of path. See Abs |
filter "text" "regex" | keeps only the lines matching the given regex, analogous to grep -E |
reverseFilter "text" "regex" | keeps only the lines not matching the given regex, analogous to grep -vE |
title "foo" | "titlenize" the string using english as language. See Title |
mdv2escape "foo" | escape characters according to MarkdownV2, especially useful in the Telegram integration |
envOrDefault "NAME" "value" | either gets the value of the given environment variable, or the given default |
isEnvSet "NAME" | returns true if the env is set and not empty, false otherwise |
$m := map "KEY" "VALUE" | creates a map from a list of key and value pairs. Both keys and values must be of type string |
indexOrDefault $m "KEY" "value" | either gets the value of the given key or the given default value from the given map |
incpatch "v1.2.4" | increments the patch of the given version[^panic-if-not-semver] |
incminor "v1.2.4" | increments the minor of the given version[^panic-if-not-semver] |
incmajor "v1.2.4" | increments the major of the given version[^panic-if-not-semver] |
urlPathEscape "foo/bar" | escapes URL paths. See PathEscape (since v2.5) |
blake2b .ArtifactPath | blake2b checksum of the artifact. See Blake2b (since v2.9) |
blake2s .ArtifactPath | blake2s checksum of the artifact. See Blake2s (since v2.9) |
crc32 .ArtifactPath | crc32 checksum of the artifact. See CRC32 (since v2.9) |
md5 .ArtifactPath | md5 checksum of the artifact. See MD5 (since v2.9) |
sha224 .ArtifactPath | sha224 checksum of the artifact. See SHA224 (since v2.9) |
sha384 .ArtifactPath | sha384 checksum of the artifact. See SHA384 (since v2.9) |
sha256 .ArtifactPath | sha256 checksum of the artifact. See SHA256 (since v2.9) |
sha1 .ArtifactPath | sha1 checksum of the artifact. See SHA1 (since v2.9) |
sha512 .ArtifactPath | sha512 checksum of the artifact. See SHA512 (since v2.9) |
sha3_224 .ArtifactPath | sha3_224 checksum of the artifact. See SHA3-224 (since v2.9) |
sha3_384 .ArtifactPath | sha3_384 checksum of the artifact. See SHA3-384 (since v2.9) |
sha3_256 .ArtifactPath | sha3_256 checksum of the artifact. See SHA3-256 (since v2.9) |
sha3_512 .ArtifactPath | sha3_512 checksum of the artifact. See SHA3-512 (since v2.9) |
mustReadFile "/foo/bar.txt" | reads the file contents or fails if it can't be read (since v2.12) |
readFile "/foo/bar.txt" | reads the file contents if it it can be read, or return empty string (since v2.12) |