More than 3 years have passed since last update.

【Ruby on Rails】Gemの依存関係を監視させる　～ GitHub Dependabot ～

Last updated at 2021-09-07Posted at 2021-08-13

環境

Rails 6.1.4
ruby 2.6.3p62 (2019-04-16 revision 67580) [x86_64-linux]
Amazon Linux2

Dependabotとは

Gem(パッケージ)の依存関係を更新してくれます！

具体的には…

Gem側でバージョン更新される(gem'otinu'1.22 から gem'otinu'1.3がリリースされる等)
DependabotがGemの更新を検知
更新されたGemに関連するその他のGemも含め、確認をする
確認後、更新された内容をGitHubのプルリクエストとして上げてくれる

数か月Gem放置して、あるときbundle叩いたらアプリが動かない…??
Gemのバージョン管理が大変だから今まで放置してしまってた!!

特にGemの入り組んだRailsは想像に難くないですね…。

そんな問題をDependabotは大幅に改善してくれます！

2種類のDependabot

「Dependabotを知ったばかり」の方、必見ですので前置きとしてご紹介します。

ネット上の色々な記事を見てみると、どうやら現在の世の中には2種類のDependabotがあるようです。

理由はDependabotがGitHubに買収されたとのこと。
(リンク先、最下行)

2021/08/11現在 Dependabotには

買収前Ver
買収後ver

2種類が存在する様子です。

この2種類のうち、①は8月に使えなくなるようで、①を使っていたユーザーは②への移行が必要とのことです。

この関係で公式ドキュメントやネット上の投稿記事にも新旧Dependabotの記事が入り混じっていました。
この時点までお読みの方は、Dependabotについて他の記事を検索する際もこの点はお気をつけください。

無難なのはGitHub(買収後)の公式ドキュメントを参照されるのがよろしいかと思います！
依存関係の更新の設定オプション - GitHub Docs

手順

①GitHubのご自身のリポジトリから、上部タブの「Insights」を選択
②サイドバーより「Dependency graph」を選択
③画面中央部のタブより「Dependabot」を選択
④画面中央の緑色ボタン「Enable Dependabot」をクリック

⑤緑色ボタン「Create config file」をクリック

⑥ここで、Dependabot用のYMLファイルにコードを記述します。

「とりあえず、Dependabotを入れたい」方は後述の【記述した内容】をご参照ください！

ーーーーー

⑦YMLファイルの記述が終わりましたら、「dependabot」を作成します。
今回の場合、YMLファイルにtarget-branch: "dependabot"と記述をしたため、このブランチがないとDependabotは「dependabotブランチがないよ」と、エラーを返します。

⑧再度、GitHubの画面から手順③～⑤の画面に戻ると「Gemのアイコン + 'bundler'」と中央バー左端に表示され、反対の右端がリンクになっているので、クリックします。

⑨画面中央、赤色領域内のボタン「Check for updates」をクリック

⑩何も問題がなければ、下記のような画面が表示されます。
今後は依存関係の更新をDependabotが検知した際にプルリクエストを発行してくれます。

⑪実際にDependabotが機能してポートフォリオにプルリクエストを発行してくれました。
今回はBootstrapをバージョン4.6から5.1にバージョンアップをする内容でした。
テスト用のトピックブランチで確認したところ、レイアウトが大幅に崩れ、ハンバーガーメニューが動かなかったので、承認を却下しました💦

⑪(注意点)
もし、⑪のように2回目のプルリクエストを却下した場合は1回目のプルリクエスト承認をなかったことにする(Revert)必要があります。
プルリクエストの履歴を辿っていただき、Revertボタンをクリックします。

注意点

手順⑩の後の説明となりますが、今回の記述内容では1回目のプルリクエストはそのまま承認しても、本命ブランチには何も影響がありません。
1回目のプルリクエストを承認後、2回目のプルリクエストとして「dependabotブランチを本命ブランチとマージしますか？」との旨が発行されます。
2回目のプルリクエストを許可する前に、1回目のプルリクエストを承認したdependabotブランチをご自身のテスト環境などにクローンして、テストすることを推奨致します。

GitHubもバージョン戦略(versioning-strategy)を用意しているように、「Dependabotがあればパッケージの依存関係はもう放置で大丈夫」という訳ではありません。
一生懸命作ったアプリケーションが大事にならないように、最後には人の目で確認することが不可欠です。

記述した内容

今回は制作したポートフォリオで記述した内容を使用しました。

version: 2
updates:
  - package-ecosystem: "bundler"
    directory: "/"
    target-branch: "dependabot"
    open-pull-requests-limit: 10
    versioning-strategy: increase
    schedule:
      interval: "daily"
      timezone: "Asia/Tokyo"
    ignore:
      - dependency-name: "rails"
        update-types: ["version-update:semver-major"]
      - dependency-name: "puma"
        update-types: ["version-update:semver-major"]

`target-branch: "dependabot"` 初めから本命ブランチにプルリクエストを発行することはせず、指定したトピックブランチ(今回はdependabotブランチ)にプルリクエストが発行されるようにします。この場合であれば、仮にdependabotブランチへのプルリクエストを承認しても本命ブランチにマージしなければ問題はありません。

open-pull-requests-limit: 10
プルリクエストの発行数の上限を設定します。AWS関連のGemなど更新頻度の高いGemを入れていると、プルリクエストもドンドン溜まっていくので、ある程度の数で抑えるようにしています。

versioning-strategy: increase
RailsやPumaといった主要なGemの更新をマイナーバージョンのみにした関係でDependabotが余り動かないのではないかと考えました。
Dependabotがしっかりと動作することを確認する目的で、頻繁にプルリクエストを発行してくれるであろう、increaseをバージョン戦略に選びました。

ignore:
      - dependency-name: "rails"
        update-types: ["version-update:semver-major"]
      - dependency-name: "puma"
        update-types: ["version-update:semver-major"]