Skip to content

Latest commit

 

History

History
99 lines (71 loc) · 2.72 KB

announce.md

File metadata and controls

99 lines (71 loc) · 2.72 KB
Raw
title
Announce

GoReleaser can also announce new releases, currently, to Twitter and Slack only.

It runs at the very end of the pipeline.

Twitter

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

  • TWITTER_CONSUMER_KEY
  • TWITTER_CONSUMER_SECRET
  • TWITTER_ACCESS_TOKEN
  • TWITTER_ACCESS_TOKEN_SECRET

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

# .goreleaser.yml
announce:
  twitter:
    # Wether its enabled or not.
    # Defaults to false.
    enabled: true

    # Message template to use while publishing.
    # Defaults to `{{ .ProjectName }} {{ .Tag }} is out! Check it out at {{ .GitURL }}/releases/tag/{{ .Tag }}`
    message_template: 'Awesome project {{.Tag}} is out!'

Slack

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

  • SLACK_WEBHOOK

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

# .goreleaser.yml
announce:
  slack:
    # Wether its enabled or not.
    # Defaults to false.
    enabled: true

    # Message template to use while publishing.
    # Defaults to `{{ .ProjectName }} {{ .Tag }} is out! Check it out at {{ .GitURL }}/releases/tag/{{ .Tag }}`
    message_template: 'Awesome project {{.Tag}} is out!'

    # The name of the channel that the user selected as a destination for webhook messages.
    channel: '#channel'

    # Set your Webhook's user name.
    username: ''

    # Emoji to use as the icon for this message. Overrides icon_url.
    icon_emoji: ''

    # URL to an image to use as the icon for this message.
    icon_url: ''

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

Reddit

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.yml config:

# .goreleaser.yml
announce:
  reddit:
    # Wether its enabled or not.
    # Defaults to false.
    enabled: true

    # Application ID for Reddit Application
    application_id: ""

    # Username for your Reddit account
    username: ""

    # URL template to use while publishing.
    # Defaults to `{{ .GitURL }}/releases/tag/{{ .Tag }}`
    url_template: 'https://github.com/goreleaser/goreleaser/releases/tag/{{ .Tag }}'

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