mirror of https://github.com/goreleaser/goreleaser.git synced 2025-03-29 21:47:01 +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.3 KiB

Raw Blame History

Webhook

Since: v1.3

Webhooks are a way to receive notifications. With this Goreleaser functionality, you can send events to any server exposing a webhook.

If your endpoints are not secure, you can use following environment variables to configure them:

BASIC_AUTH_HEADER_VALUE like Basic <base64(username:password)>
BEARER_TOKEN_HEADER_VALUE like Bearer <token>

Add following to your .goreleaser.yaml config to enable the webhook functionality:

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

    # Check the certificate of the webhook.
    skip_tls_verify: true

    # Message template to use while publishing.
    #
    # Default: '{{ .ProjectName }} {{ .Tag }} is out! Check it out at {{ .ReleaseURL }}'
    # Templates: allowed
    message_template: '{ "title": "Awesome project {{.Tag}} is out!"}'

    # Content type to use.
    #
    # Default: 'application/json; charset=utf-8'
    content_type: "application/json"

    # Endpoint to send the webhook to.
    endpoint_url: "https://example.com/webhook"
    # Headers to send with the webhook.
    # For example:
    # headers:
    #   Authorization: "Bearer <token>"
    headers:
      User-Agent: "goreleaser"

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

1.3 KiB Raw Blame History

Webhook

1.3 KiB

Raw Blame History