Skip to content
auto Logo

Twitter Plugin

Post tweets after a release is made.

Prerequisites

To post tweets to twitter you need the following secrets set in your environment:

  • TWITTER_ACCESS_TOKEN
  • TWITTER_ACCESS_TOKEN_SECRET
  • TWITTER_CONSUMER_KEY
  • TWITTER_CONSUMER_KEY_SECRET

Installation

This plugin is not included with the auto CLI installed via NPM. To install:

npm i --save-dev @auto-it/twitter
# or
yarn add -D @auto-it/twitter
npm i --save-dev @auto-it/twitter
# or
yarn add -D @auto-it/twitter

Usage

Simply supply the names of the account to filter

{
  "plugins": [
    [
      "twitter",
      {
        /* options */
      }
    ]
  ]
}
{
  "plugins": [
    [
      "twitter",
      {
        /* options */
      }
    ]
  ]
}

Options

Message

You can configure the message posted to twitter. The message option should use the following special tokens to create a tweet.

  • %release - The version bump (major, minor, patch)
  • %package - The name of the package
  • %notes - Your release notes truncated to fit in the tweet
  • %link - A link to your the release on GitHub
  • %version - The latest version number

Default:

A new %release version of %package was released!

%notes

%link
A new %release version of %package was released!

%notes

%link

{
  "plugins": [
    ["twitter", { "message": "v%version of %package was released!\n\n%link" }]
  ]
}
{
  "plugins": [
    ["twitter", { "message": "v%version of %package was released!\n\n%link" }]
  ]
}

Threshold

By default the twitter plugin will only tweet if the version difference between the latest and the last release is greater than a minor.

{
  "plugins": [["twitter", { "threshold": "major" }]]
}
{
  "plugins": [["twitter", { "threshold": "major" }]]
}