NPMモジュール内で依存しているモジュールを自動的にアップデートする方法(Greenkeeper編)

NPMモジュール内で依存しているモジュールのバージョンが古くなった場合に、Greenkeeperを使って自動的にモジュールのバージョンをアップデートする方法を紹介します。

見出し

1 はじめに
2 Greenkeeperの導入方法
3 最後に
- 3.1 関連記事

はじめに

NPMモジュールを作成して公開してしばらくすると、以下のように依存しているモジュールが古くなっていきます。

これを毎回手動でアップデートしていくのは手間ですが、セキュリティ面などのバグフィックスもあるのでアップデートは可能な限り行いたいことでしょう。

そこで、自動的に古くなっている依存しているパッケージを検出し、アップデートするためのプルリクエストを送ってくれるのがGreenkeeperというサービスです。しかもパブリックリポジトリであれば無料です。

それではGreenkeeperをNPMモジュールのリポジトリに導入していきましょう。

Greenkeeperの導入方法

GreenkeeperとGitHubを連携する

まずは「Greenkeeper」のページに行き、「YOUR ACCOUNT」をクリックします。

「Login with GitHub」をクリックします。

「Authorize greenkeeper」をクリックします。

パスワードを入力して「Confirm password」をクリックします。

GreenkeeperのページにGitHubのアカウントが表示されます。

これで連携が完了しました。

リポジトリを登録する

次に、対象のNPMモジュールのリポジトリをGreenkeeperに登録します。Greenkeeperのページからアカウントをクリックします。

「Repositories」タブで「Greenkeeper installation page on GitHub」をクリックします。

全てのリポジトリを登録することもできますが、今回はリポジトリを選択して登録します。「Only select repositories」にチェックを入れ、「Select repositories」からリポジトリを選択し、「Install」をクリックします。

ダッシュボードにリポジトリ名が表示されます。

これでリポジトリの登録が完了しました。

古くなったモジュールをアップデートする

依存しているモジュールが古くなるとGreenkeeperが検出して、以下のように「Update dependencies to enable Greenkeeper」のプルリクエストが自動的に発行されます。(今回は最初なのでGreenkeeperを初期化するためのプルリクエストも含まれています)

通常のGitHubのフロー通りに「Merge pull request」をクリックします。

すると、マージされます。

Geenkeeperのプルリクエストをマージすると、Geenkeeperのページのリポジトリのステータスが「Enabled」になります。

これで古くなったモジュールがアップデートされました。

最後に

いかがでしたか？これで自作のNPMモジュールで依存しているモジュールが古くなっても自動的にプルリクエストが発行されるようになりました。便利ですね。

この記事を書いた人
最新の記事

KD

世界を旅し日本を愛するエンジニア。大学でコンピュータサイエンスの楽しさを学び、日本の大手IT企業で働く中で、新しい技術やスケールするビジネスが北米にある事に気づく。世界に挑戦するための最大の壁が英語であったため、フィリピン留学およびカナダ留学を経て英語を上達させた。現在は日本在住でエンジニアとして働きつつ、次の挑戦に備えて世界の動向を注視している。挑戦に終わりはない。このブログでは、エンジニアやデザイナー向けの技術情報から、海外に留学したい人向けの留学情報、海外に興味がある人向けの海外旅行情報など、有益な情報を提供しています。