diff --git a/www/docs/customization/changelog.md b/www/docs/customization/changelog.md index 8de29ae2a..ceb4ec804 100644 --- a/www/docs/customization/changelog.md +++ b/www/docs/customization/changelog.md @@ -86,6 +86,13 @@ changelog: regex: '.*build.*' order: 2 + # Divider to use between groups. + # + # Defaults to empty. + # + # Since: v1.16.0-pro + divider: '---' + filters: # Commit messages matching the regexp listed here will be removed from # the changelog diff --git a/www/docs/customization/templates.md b/www/docs/customization/templates.md index a653c3cf2..9542d443f 100644 --- a/www/docs/customization/templates.md +++ b/www/docs/customization/templates.md @@ -50,6 +50,7 @@ Key |Description `.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 bellow for fields. Since v1.16-pro. [^version-prefix]: The `v` prefix is stripped, and it might be changed in `snapshot` and `nightly` builds. @@ -63,6 +64,26 @@ Key |Description [^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 diff --git a/www/docs/static/schema-pro.json b/www/docs/static/schema-pro.json index 04f05b739..d71c838ae 100644 --- a/www/docs/static/schema-pro.json +++ b/www/docs/static/schema-pro.json @@ -510,6 +510,9 @@ }, "type": "array" }, + "divider": { + "type": "string" + }, "abbrev": { "type": "integer" }, @@ -2609,6 +2612,12 @@ }, "type": "array" }, + "depends": { + "items": { + "type": "string" + }, + "type": "array" + }, "goamd64": { "type": "string" }