1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-04-09 07:14:08 +02:00
Carlos Alexandro Becker cc2805b801
docs: improve wording
Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com>
2023-04-30 00:02:38 +00:00

50 lines
1.3 KiB
Markdown

# WebHooks
> 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` configuration to enable the WebHook functionality:
```yaml
# .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](/customization/templates/).