goreleaser/www/docs/customization/templates.md

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

On fields that support templating, these fields are always available:

Key	Description
.ProjectName	the project name
.Version	the version being released1
.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
.Major	the major part of the version2
.Minor	the minor part of the version2
.Patch	the patch part of the version2
.Prerelease	the prerelease part of the version, e.g. beta2
.RawVersion	composed of {Major}.{Minor}.{Patch} 2
.ReleaseNotes	the generated release notes, available after the changelog step has been executed
.IsSnapshot	true if --snapshot is set, false otherwise
.IsNightly	true if --nightly is set, false otherwise
.Env	a map with system's environment variables
.Date	current UTC date in RFC 3339 format
.Timestamp	current UTC time in Unix format
.ModulePath	the go module path, as reported by go list -m
incpatch "v1.2.4"	increments the patch of the given version3
incminor "v1.2.4"	increments the minor of the given version3
incmajor "v1.2.4"	increments the major of the given version3
.ReleaseURL	the current release download url4
.Summary	the git summary, e.g. v1.0.0-10-g34f56g35
.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 out6
.TagContents	the annotated tag message, or the message of the commit it points out7
.Runtime.Goos	equivalent to runtime.GOOS
.Runtime.Goarch	equivalent to runtime.GOARCH

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	GOOS8
.Arch	GOARCH8
.Arm	GOARM8
.Mips	GOMIPS8
.Binary	binary name
.ArtifactName	archive name
.ArtifactPath	absolute path to artifact

nFPM extra fields

On the nFPM name template field, you can use those extra fields as well:

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 nFPM9

Functions

On all fields, you have these available functions:

Usage	Description
replace "v1.2" "v" ""	replaces all matches. See ReplaceAll
time "01/02/2006"	current UTC time in the specified format (this is not deterministic, a new time for every call)
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
abs .ArtifactPath	returns an absolute representation of path. See Abs

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_NR=$(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

!!! success "GoReleaser Pro" Custom template variables support is a GoReleaser Pro feature.

You can also declare custom variables. This feature is specially useful with includes, so you can have more generic config 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.

---

1. The v prefix is stripped and it might be changed in snapshot and nightly builds. ↩︎

2. Assuming Tag is a valid a SemVer, otherwise empty/zeroed. ↩︎

3. Will panic if not a semantic version. ↩︎

4. Composed from the current SCM's download URL and current tag. For instance, on GitHub, it'll be https://github.com/{owner}/{repo}/releases/tag/{tag}. ↩︎

5. It is generated by git describe --dirty --always --tags, the format will be {Tag}-$N-{CommitSHA} ↩︎

6. As reported by git tag -l --format='%(contents:subject)' ↩︎

7. As reported by git tag -l --format='%(contents)' ↩︎

8. Might have been replaced by archives.replacements. ↩︎

9. 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. ↩︎