Name Templates¶

Several fields in GoReleaser'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²
`.Branch`	the current git branch
`.PrefixedTag`	the current git tag prefixed with the monorepo config tag prefix (if any)
`.Tag`	the current git tag
`.PrefixedPreviousTag`	the previous git tag prefixed with the monorepo config tag prefix (if any)
`.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³
`.Minor`	the minor part of the version³
`.Patch`	the patch part of the version³
`.Prerelease`	the prerelease part of the version, e.g. `beta`³
`.RawVersion`	composed of `{Major}.{Minor}.{Patch}` ³
`.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⁴
`.Summary`	the git summary, e.g. `v1.0.0-10-g34f56g3`⁵
`.PrefixedSummary`	the git summary prefixed with the monorepo config tag prefix (if any)
`.TagSubject`	the annotated tag message subject, or the message subject of the commit it points out⁶
`.TagContents`	the annotated tag message, or the message of the commit it points out⁷
`.TagBody`	the annotated tag message's body, or the message's body of the commit it points out⁷
`.Runtime.Goos`	equivalent to `runtime.GOOS`
`.Runtime.Goarch`	equivalent to `runtime.GOARCH`
`.Artifacts`	the current artifact list. See table below for fields¹

Artifacts¶

If you use the .Artifacts field, it evaluates to an artifact.Artifact list. You should be able to use all its fields on each item:

.Name
.Path
.Goos
.Goarch
.Goarm
.Gomips
.Goamd64
.Goarm64 (since v2.4)
.Gomips64 (since v2.4)
.Goppc64 (since v2.4)
.Goriscv64 (since v2.4)
.Go386 (since v2.4)
.Type
.Extra

GoReleaser Pro

One or more features are exclusively available with GoReleaser Pro.

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)
`.Binary`	artifact name
`.ArtifactID`	artifact id (since v2.3¹)
`.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.⁸
`.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 ToLower
`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⁹
`incminor "v1.2.4"`	increments the minor of the given version⁹
`incmajor "v1.2.4"`	increments the major of the given version⁹
`list "a" "b" "c"`	makes a list of strings¹
`in (list "a" "b" "c") "b"`	checks if a slice contains a value¹
`urlPathEscape "foo/bar"`	escapes URL paths. See PathEscape (since v2.5)

With all those fields, you may be able to compose the name of your artifacts pretty much the way you want:

example_template: '{{ tolower .ProjectName }}_{{ .Env.USER }}_{{ time "2006" }}'

For example, if you want to add the go version to some artifact:

foo_template: "foo_{{ .Env.GOVERSION }}"

And then you can run:

GOVERSION=$(go version | awk '{print $3;}') goreleaser

Warning

Note that those are hypothetical examples and the fields foo_template and example_template are not valid GoReleaser configurations.

Custom variables¶

GoReleaser Pro

One or more features are exclusively available with GoReleaser Pro.

You can also declare custom variables. This feature is specially useful with includes, so you can have more generic configuration files.

Usage is as simple as you would expect:

# .goreleaser.yaml
variables:
  description: my project description
  somethingElse: yada yada yada
  empty: ""

And then you can use those fields as {{ .Var.description }}, for example.

This feature is only available in GoReleaser Pro. ↩↩↩↩
The v prefix is stripped, and it might be changed in snapshot and nightly builds. ↩
Assuming Tag is a valid a SemVer, otherwise empty/zeroed. ↩↩↩↩↩
Composed of the current SCM's download URL and current tag. For instance, on GitHub, it'll be https://github.com/{owner}/{repo}/releases/tag/{tag}. ↩
It is generated by git describe --dirty --always --tags, the format will be {Tag}-$N-{CommitSHA} ↩
As reported by git tag -l --format='%(contents:subject)' ↩
As reported by git tag -l --format='%(contents)' ↩↩
Please beware: some OSs might have the same names for different ARM versions, for example, for Debian both ARMv6 and ARMv7 are called armhf. Make sure that's not your case otherwise you might end up with colliding names. It also does not handle multiple GOAMD64 versions. ↩
Will panic if not a semantic version. ↩↩↩