go/goreleaser
go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-22 04:08:49 +02:00
Code Issues Releases Activity
goreleaser/www/docs/customization/templates.md
Ernst Widerberg d2d910f54f
docs: fix typos (#4406)
2023-11-06 09:14:07 -03:00

207 lines
14 KiB
Markdown
Raw Blame History

# 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[^version-prefix] |
| `.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 |
| `.IsGitDirty` | whether or not current git state is dirty. Since v1.19 |
| `.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. Since v1.17 |
| `.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 |
| `.Now` | current UTC date as `time.Time` struct, allows all `time.Time` functions (e.g. `{{ .Now.Format "2006" }}`) . Since v1.17 |
| `.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 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] |
| `.ReleaseURL` | the current release download url[^scm-release-url] |
| `.Summary` | the git summary, e.g. `v1.0.0-10-g34f56g3`[^git-summary] |
| `.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[^git-tag-subject]. Since v1.2 |
| `.TagContents` | the annotated tag message, or the message of the commit it points out[^git-tag-body]. Since v1.2 |
| `.TagBody` | the annotated tag message's body, or the message's body of the commit it points out[^git-tag-body]. Since v1.2 |
| `.Runtime.Goos` | equivalent to `runtime.GOOS`. Since v1.5 |
| `.Runtime.Goarch` | equivalent to `runtime.GOARCH`. Since v1.5 |
| `.Artifacts` | the current artifact list. See table below for fields. Since v1.16 (pro) |
[^version-prefix]:
The `v` prefix is stripped, and it might be changed in
`snapshot` and `nightly` builds.
[^tag-is-semver]: Assuming `Tag` is a valid a SemVer, otherwise empty/zeroed.
[^panic-if-not-semver]: Will panic if not a semantic version.
[^scm-release-url]:
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}`.
[^git-summary]:
It is generated by `git describe --dirty --always --tags`, the
format will be `{Tag}-$N-{CommitSHA}`
[^git-tag-subject]: As reported by `git tag -l --format='%(contents:subject)'`
[^git-tag-body]: As reported by `git tag -l --format='%(contents)'`
## Artifacts
If you use the `.Artifacts` field, it evaluates to an
[`artifact.Artifact` list](https://pkg.go.dev/github.com/goreleaser/goreleaser@main/internal/artifact#Artifact).
You should be able to use all its fields on each item:
- `.Name`
- `.Path`
- `.Goos`
- `.Goarch`
- `.Goarm`
- `.Gomips`
- `.Goamd64`
- `.Type`
- `.Extra`
!!! success "GoReleaser Pro"
The `.Artifacts` template variable is [GoReleaser Pro feature](/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` |
| `.Binary` | binary name |
| `.ArtifactName` | archive name |
| `.ArtifactPath` | absolute path to artifact |
| `.ArtifactExt` | binary extension (e.g. `.exe`). Since v1.11 |
## 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. Since v1.16 |
[^arm-names]:
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.
## Release body extra fields
In the `release.body` field, you can use these extra fields:
| Key | Description |
| ------------ | ----------------------------------------------------------------------------------- |
| `.Checksums` | the current checksum file contents. Only available in the release body. Since v1.19 |
## Functions
On all fields, you have these available functions:
| Usage | Description |
|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
| `replace "v1.2" "v" ""` | replaces all matches. See [ReplaceAll](https://golang.org/pkg/strings/#ReplaceAll). |
| `split "1.2" "."` | split string at separator. See [Split](https://golang.org/pkg/strings/#Split). Since v1.11 |
| `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](https://golang.org/pkg/strings/#ToLower). |
| `toupper "v1.2"` | makes input string uppercase. See [ToUpper](https://golang.org/pkg/strings/#ToUpper). |
| `trim " v1.2 "` | removes all leading and trailing white space. See [TrimSpace](https://golang.org/pkg/strings/#TrimSpace). |
| `trimprefix "v1.2" "v"` | removes provided leading prefix string, if present. See [TrimPrefix](https://golang.org/pkg/strings/#TrimPrefix). |
| `trimsuffix "1.2v" "v"` | removes provided trailing suffix string, if present. See [TrimSuffix](https://pkg.go.dev/strings#TrimSuffix). |
| `dir .Path` | returns all but the last element of path, typically the path's directory. See [Dir](https://golang.org/pkg/path/filepath/#Dir). |
| `base .Path` | returns the last element of path. See [Base](https://golang.org/pkg/path/filepath/#Base). Since v1.16 |
| `abs .ArtifactPath` | returns an absolute representation of path. See [Abs](https://golang.org/pkg/path/filepath/#Abs). |
| `filter "text" "regex"` | keeps only the lines matching the given regex, analogous to `grep -E`. Since v1.6 |
| `reverseFilter "text" "regex"` | keeps only the lines **not** matching the given regex, analogous to `grep -vE`. Since v1.6 |
| `title "foo"` | "titlenize" the string using english as language. See [Title](https://pkg.go.dev/golang.org/x/text/cases#Title). Since v1.14 |
| `mdv2escape "foo"` | escape characters according to MarkdownV2, especially useful in the Telegram integration. Since v1.19 |
| `envOrDefault "NAME" "value"` | either gets the value of the given environment variable, or the given default. Since v1.19 |
| `$m := map "KEY" "VALUE"` | creates a map from a list of key and value pairs. Both keys and values must be of type `string`. Since v1.21 |
| `indexOrDefault $m "KEY" "value"` | either gets the value of the given key or the given default value from the given map. Since v1.21 |
With all those fields, you may be able to compose the name of your artifacts
pretty much the way you want:
```yaml
example_template: '{{ tolower .ProjectName }}_{{ .Env.USER }}_{{ time "2006" }}'
```
For example, if you want to add the go version to some artifact:
```yaml
foo_template: "foo_{{ .Env.GOVERSION }}"
```
And then you can run:
```sh
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](/pro/).
You can also declare custom variables. This feature is specially useful with
[includes](/customization/includes/), so you can have more generic configuration
files.
Usage is as simple as you would expect:
```yaml
# .goreleaser.yaml
variables:
description: my project description
somethingElse: yada yada yada
empty: ""
```
And then you can use those fields as `{{ .Var.description }}`, for example.
Reference in New Issue View Git Blame Copy Permalink