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:

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
• .Type
• .Extra

Single-artifact extra fields¶

On fields that are related to a single artifact (e.g., the binary name), you may have some extra fields:

nFPM extra fields¶

In the nFPM name template field, you can use those extra fields:

Release body extra fields¶

In the release.body field, you can use these extra fields:

Functions¶

On all fields, you have these available functions:

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

Custom variables¶

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.