1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-26 04:22:05 +02:00
Carlos Alexandro Becker d524d93086
docs: standarizing docs defaults, since, etc (#3898)
- [x] if the default is the zero-value for the field, do not specify
- [ ] TODO: add a "how to read this docs" section somewhere explaining
that
- [x] if the change was introduced in a v1.x.0, say only v1.x
- [x] drop trail ending `.` from Since, Default, etc
- [x] wording: always use `Default: ` instead of `Defaults to` and
others
- [x] add a note to templateable fields
- [x] default value of a field, if its a string, always between single
quotes `'`

---------

Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
2023-04-02 17:16:21 -03:00

33 lines
720 B
Markdown

# Closing Milestones
GoReleaser can close repository milestones after successfully publishing all
artifacts.
Let's see what can be customized in the `milestones` section:
```yaml
# .goreleaser.yaml
milestones:
# You can have multiple milestone configs
-
# Repository for the milestone
# Default is extracted from the origin remote URL
repo:
owner: user
name: repo
# Whether to close the milestone
close: true
# Fail release on errors, such as missing milestone.
fail_on_error: true
# Name of the milestone
#
# Default: '{{ .Tag }}'
name_template: "Current Release"
```
!!! tip
Learn more about the [name template engine](/customization/templates/).