mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-08 03:31:59 +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

1.1 KiB

Raw Blame History

Discord

To use Discord, you need to create a Webhook, and set following environment variables on your pipeline:

DISCORD_WEBHOOK_ID
DISCORD_WEBHOOK_TOKEN

After this, you can add following section to your .goreleaser.yaml config:

# .goreleaser.yaml
announce:
  discord:
    # 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!'

    # Set author of the embed.
    #
    # Default: 'GoReleaser'
    author: ''

    # Color code of the embed. You have to use decimal numeral system, not hexadecimal.
    #
    # Default: '3888754' (the grey-ish from GoReleaser)
    color: ''

    # URL to an image to use as the icon for the embed.
    #
    # Default: 'https://goreleaser.com/static/avatar.png'
    icon_url: ''

!!! tip Learn more about the name template engine.

1.1 KiB Raw Blame History

Discord

1.1 KiB

Raw Blame History