VersionEyeの情報をSlackに投稿するnpmパッケージを作成しました

概要

VersionEyeの情報をSlackに投稿するnpmパッケージを作成したので、それについて解説します。

VersionEyeとは

VersionEyeは、GitHub上のプロジェクトが依存するライブラリ更新を支援するサービスです。

www.versioneye.com

プロジェクトが依存するライブラリに対して、最新バージョンの通知、セキュリティチェック、ライセンスチェックを行ってくれます。依存ライブラリを継続的に更新することによって変更の粒度が小さくなり、容易に変更への迅速な対応が可能になります。

同種のサービスとしては、gemnasiumやDavidなどがありますが、VersionEyeはサポートしているパッケージマネージャの豊富さが魅力的です。

Composer (PHP)
Bundler (Ruby)
PIP (Python)
NPM (Node.JS)
Bower (JavaScript)
CocoaPods (Objective-C)
Maven (Java)
SBT (Scala)
Gradle (Groovy)
Leiningen (Clojure)
Nuget (Microsoft .NET platform)
Biicode (C/C++)
Berkshelf (Chef)

プライベートリポジトリ1つと公開ポジトリ4つまで無料で使えます。

versioneye-slack

VersionEyeから依存ライブラリの状態を教えてくれる通知がメールではくるのですが、残念ながらSlack連携が現時点では用意されていません。開発チーム全体に共有されるところに通知を投げたいので、Slackに投稿するためのツールをnpmパッケージで作成しました。

www.npmjs.com

コマンドラインツールとして実装しているので、使い方は簡単です。

$ npm install versioneye-slack -g

でインストールして、

$ versioneye-slack project <projectName> --versioneye-api-key <key> --slack-webhook-url <url>

で↓のような投稿がSlackに飛びます。

f:id:miya-jan:20170106152609p:plain

VersionEyeのAPIキーとSlackのWebhook URLは環境変数でも渡せるようにしていて、それぞれ VERSIONEYE_API_KEY と SLACK_WEBHOOK_URL が --versioneye-api-key と --slack-webhook-url に対応しています。

CLIだけでなく、プログラム上からでも呼び出せます。

const VersionEyeSlack = require('versioneye-slack');
 
const versioneyeApiKey = '<api key for versioneye>';
const slackWebhookUrl = '<webhook url for slack>';
const versioneyeSlack = new VersionEyeSlack(versioneyeApiKey, slackWebhookUrl);
versioneyeSlack.postProjectSummary('project name').then(response => {
    console.log(response);
});