1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-08 03:31:59 +02:00
goreleaser/www/docs/customization/announce/opencollective.md
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

890 B

OpenCollective

For it to work, you'll need to create a personal token (https://opencollective.com/<user>/admin/for-developers) and set the environment variable on your pipeline:

  • OPENCOLLECTIVE_TOKEN

Then, you can add something like the following to your .goreleaser.yaml config:

# .goreleaser.yaml
announce:
  opencollective:
    # Whether its enabled or not.
    enabled: true

    # Collective slug
    # https://opencollective.com/<slug>
    slug: 'goreleaser'

    # Title for the update
    #
    # Default: '{{ .Tag }}'
    # Templates: allowed
    title_template: 'Release of {{ .Tag }}'

    # Message to use while publishing. It can be HTML!
    #
    # Default: '{{ .ProjectName }} {{ .Tag }} is out!<br/>Check it out at <a href="{{ .ReleaseURL }}">{{ .ReleaseURL }}</a>'
    # Templates: allowed
    message_template: 'Awesome project {{.Tag}} is out!'