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

SMTP

For it to work, you'll need to set some environment variables on your pipeline:

SMTP_PASSWORD

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

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

    # SMTP Host.
    #
    # Default: $SMTP_HOST
    host: "smtp.gmail.com"

    # SMTP Port
    #
    # Default: $SMTP_PORT
    port: 587

    # Sender of the email
    from: ""

    # Receivers of the email
    to:
      - ""
      - ""

    # Owner of the email
    #
    # Default: $SMTP_USERNAME
    username: ""

    # Body to use within the email.
    #
    # Default: 'You can view details from: {{ .ReleaseURL }}'
    # Templates: allowed
    body_template: 'https://github.com/goreleaser/goreleaser/releases/tag/{{ .Tag }}'

    # Subject template to use within the email subject.
    #
    # Default: '{{ .ProjectName }} {{ .Tag }} is out!'
    # Templates: allowed
    subject_template: ''GoReleaser {{ .Tag }} was just released!''

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

1.1 KiB Raw Blame History

SMTP

1.1 KiB

Raw Blame History