mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-03-29 21:47:01 +02:00
d524d93086
- [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>
55 lines
1.7 KiB
Markdown
55 lines
1.7 KiB
Markdown
# Slack
|
|
|
|
For it to work, you'll need to [create a new Incoming Webhook](https://api.slack.com/messaging/webhooks), and set some
|
|
environment variables on your pipeline:
|
|
|
|
- `SLACK_WEBHOOK`
|
|
|
|
Then, you can add something like the following to your `.goreleaser.yaml` config:
|
|
|
|
```yaml
|
|
# .goreleaser.yaml
|
|
announce:
|
|
slack:
|
|
# Whether its enabled or not.
|
|
enabled: true
|
|
|
|
# Message template to use while publishing.
|
|
#
|
|
# Default: '{{ .ProjectName }} {{ .Tag }} is out! Check it out at {{ .ReleaseURL }}'
|
|
# Templates: allowed
|
|
message_template: 'Awesome project {{.Tag}} is out!'
|
|
|
|
# The name of the channel that the user selected as a destination for webhook messages.
|
|
channel: '#channel'
|
|
|
|
# Set your Webhook's user name.
|
|
username: ''
|
|
|
|
# Emoji to use as the icon for this message. Overrides icon_url.
|
|
icon_emoji: ''
|
|
|
|
# URL to an image to use as the icon for this message.
|
|
icon_url: ''
|
|
|
|
# Blocks for advanced formatting, see: https://api.slack.com/messaging/webhooks#advanced_message_formatting
|
|
# and https://api.slack.com/messaging/composing/layouts#adding-blocks.
|
|
#
|
|
# Attention: goreleaser doesn't check the full structure of the Slack API: please make sure that
|
|
# your configuration for advanced message formatting abides by this API.
|
|
#
|
|
# Templates: allowed
|
|
blocks: []
|
|
|
|
# Attachments, see: https://api.slack.com/reference/messaging/attachments
|
|
#
|
|
# Attention: goreleaser doesn't check the full structure of the Slack API: please make sure that
|
|
# your configuration for advanced message formatting abides by this API.
|
|
#
|
|
# Templates: allowed
|
|
attachments: []
|
|
```
|
|
|
|
!!! tip
|
|
Learn more about the [name template engine](/customization/templates/).
|