go/goreleaser
go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-02-15 13:53:25 +02:00
Code Issues Releases Activity
goreleaser/www/docs/customization/announce/telegram.md
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

993 B
Raw Blame History

Telegram

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

  • TELEGRAM_TOKEN

Also you need to know your channel's chat ID to talk with.

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

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

    # Integer representation of your channel
    #
    # Templates: allowed (since v1.15)
    chat_id: 123456

    # 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!'

You can format your message using MarkdownV2, for reference, see the Telegram Bot API.

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