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

957 B

Raw Blame History

Twitter

!!! warning Twitter has announced that API usage will no longer be free starting Feb 9, 2023.

For it to work, you'll need to create a new Twitter app, and set some environment variables on your pipeline:

TWITTER_CONSUMER_KEY
TWITTER_CONSUMER_SECRET
TWITTER_ACCESS_TOKEN
TWITTER_ACCESS_TOKEN_SECRET

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

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

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

957 B Raw Blame History

Twitter

957 B

Raw Blame History