@kibibit/announce-it NPM

How to install

Install this package as a dev dependency:

npm install --save-dev @kibibit/announce-it

How to use

Intended to run after a new release in your continues integration

Twitter Setup

You have to create a Developer Account on Twitter.

Create an App
From your apps list go to your app Details
Select the Keys and tokens tab
You'll need all 4 variables available in that page:
- API key
- API secret key
- Access token
- Access token secret

As a command line tool

You can add a dedicated script in your package.json file:

// ...
"scripts": {
  // ...
  "announce": "announce-it"
}
// ...

If executed with @semanic-release/exec:

// ...
"plugins": 
  // ...
  [
    "@semantic-release/exec",
    {
      "success": "npm run announce -- --branch ${options.branch}"
    }
  ]
  // ...
// ...

If installed as a project dependency, you can run with npx:

# should be ran inside your project
# npx
npx announce-it

# directly 
./node_modules/.bin/announce-it

If installed globally, you can run it from within any node package with the correct setup

As a node module

import { KbAnnounceIt, PackageDetails } from '@kibibit/announce-it';

const announceIt = new KbAnnounceIt({
  accessTokenKey: 'TWITTER_ACCESS_KEY',
  accessTokenSecret: 'TWITTER_ACCESS_SECRET',
  consumerKey: 'TWITTER_CONSUMER_KEY',
  consumerSecret: 'TWITTER_CONSUMER_SECRET',
  branch: 'CURRENT_BRANCH'
});

const myPackage: PackageDetails = require('./package');

// get generated tweet
const tweet: string = announceIt.generateTweet(myPackage);

console.log('going to tweet: ', tweet);

// publish tweet to twitter
announceIt.announceRelease(myPackage);

Use these Token as environment variables in this fashion:
CONSUMER_KEY = API key
CONSUMER_SECRET = API secret key
ACCESS_TOKEN_KEY = Access token
ACCESS_TOKEN_SECRET = Access token secret

Defining your Templates

Inside your package.json file, add an announcements object with tweet property.

You can then create your own tweet message template that will be posted to twitter.

{
  "name": "my-package",
  "version": "2.4.3",
  // ...
  "announcements": {
    "tweet": "Version <%= version %> of <%= package %> is live! <%= npmpage %>"
  },
}

The tweet template is generated with Lodash template.

You can use these variables: