goreleaser/reddit.md at 5d44ed14fda18831c628109ad297502dfceabb1b

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

986 B

Raw Blame History

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

REDDIT_SECRET
REDDIT_PASSWORD

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

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

    # Application ID for Reddit Application
    application_id: ""

    # Username for your Reddit account
    username: ""

    # URL template to use while publishing.
    #
    # Default: '{{ .ReleaseURL }}'
    # Templates: allowed
    url_template: 'https://github.com/goreleaser/goreleaser/releases/tag/{{ .Tag }}'

    # Title template to use while publishing.
    #
    # Default: '{{ .ProjectName }} {{ .Tag }} is out!'
    # Templates: allowed
    title_template: ''GoReleaser {{ .Tag }} was just released!''

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

986 B Raw Blame History

Reddit

986 B

Raw Blame History