コンテンツへスキップ

チームの負担にならない Dependabot の設定

最終更新日

Dependabotは、依存関係に新しいバージョンやセキュリティ修正が出ると、プルリクエストを開きます。忙しいリポジトリでデフォルトのまま使うと、小さなPRが大量に作られ、人々がそれを無視するようになってしまい、本来の目的が果たせなくなります。このガイドでは、更新が数件のまとめたPRで届き、セキュリティ修正は迅速に、低リスクの更新は自動でマージされるように設定します。

2種類の更新

  • セキュリティ更新は、依存関係に既知の脆弱性がある場合(GitHub Advisory Databaseによる)に開かれます。リポジトリの設定のAdvisoriesおよびDependabot alertsで有効にします。設定ファイルのスケジュールには従いません。
  • バージョン更新は、脆弱性の有無に関係なく新しいリリースに対して開かれ、その頻度はdependabot.ymlに従います。

両者は別物として扱ってください。セキュリティ更新は速やかにレビューしてマージすべきです。バージョン更新はまとめたり、ペースを落としたりして構いません。

推奨される初期設定

.github/dependabot.ymlを作成します:

version: 2
updates:
  - package-ecosystem: "npm"
    directory: "/"
    schedule:
      interval: "weekly"
      day: "monday"
      time: "06:00"
      timezone: "Europe/London"
    open-pull-requests-limit: 5
    groups:
      dev-dependencies:
        dependency-type: "development"
        update-types: ["minor", "patch"]
      production-minor-patch:
        dependency-type: "production"
        update-types: ["minor", "patch"]
    ignore:
      - dependency-name: "*"
        update-types: ["version-update:semver-major"]
    labels: ["dependencies"]
    commit-message:
      prefix: "chore(deps)"

  - package-ecosystem: "github-actions"
    directory: "/"
    schedule:
      interval: "monthly"
    groups:
      actions:
        patterns: ["*"]

使用しているスタックの設定は、Dependabot設定ジェネレーターで生成できます。

ノイズを減らす5つの設定

1. スケジュール。weeklyが適切な初期値です。更新の頻度が低いリポジトリではmonthlyを使ってください。毎日の実行が役立つことはまれです。曜日と時刻を固定すると、PRが予想どおりのタイミングで届きます。

2. グループ化。グループ化しないと、開発用依存関係の更新が15件あれば、PRも15件、CI実行も15回、マージも15回になります。グループ化すれば1件にまとまります。依存関係の種類、更新の種類、または名前のパターンでグループ化できます(patterns: ["eslint", "@typescript-eslint/"])。Dependabotは同じエコシステムかつ同じディレクトリの更新のみをグループ化し、グループのPRは対象のバージョン更新がある時点で開かれます。

3. メジャーバージョンはデフォルトで無視。メジャーバージョンは通常コードの変更が必要です。設定で無視し、計画的な作業として意図的にアップグレードしてください。準備が整うまで特定の依存関係を無視することもできます:

ignore:
  - dependency-name: "react"
    versions: [">=19"]

4. クールダウン。cooldownオプションは、Dependabotが新しいリリースを提案する前に遅延を入れます。悪意のあるリリースや不具合のあるリリースの多くは数日以内に発見され取り下げられるため、遅延を置くことでほとんどを避けられます:

cooldown:
  default-days: 5
  semver-major-days: 30
  semver-minor-days: 7
  semver-patch-days: 3

クールダウンに対応しているエコシステムについては、最新のDependabotオプションのリファレンスを確認してください。セキュリティ更新は、クールダウンによって遅延されないことに注意してください。

5. オープンPRの上限。open-pull-requests-limitのデフォルトはバージョン更新の場合5です。CIのキューが混雑する場合は下げてください。0に設定すると、そのエントリのバージョン更新が無効になります(セキュリティ更新には影響しません)。

CIコストを抑える

DependabotのPRごとに、CI全体が実行されます。次の方法で抑えられます:

  • 更新をグループ化する(上記)。1回の実行で多数の更新をカバーできます。
  • concurrencyとcancel-in-progressを使い、リベースされたPRで実行が積み重ならないようにする。
  • 依存関係のPRでは軽いチェック(例:ユニットテストのみ)を実行し、重いテストスイートはマージキューで実行する。GitHubのマージキューを参照してください。
  • CIに空きがある時間帯に更新をスケジュールする。

CI分の予測ツールを使い、週に20件の追加PRがどれだけのコストになるかを確認する。

安全な更新を自動マージする

CIが通過した場合、開発用依存関係のパッチおよびマイナー更新を自動マージします。dependabot/fetch-metadataを使ったワークフローで更新の種類を読み取れます:

name: dependabot-auto-merge
on: pull_request
permissions:
  contents: write
  pull-requests: write
jobs:
  auto:
    if: github.actor == 'dependabot[bot]'
    runs-on: ubuntu-latest
    steps:
      - id: meta
        uses: dependabot/fetch-metadata@v2
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
      - if: steps.meta.outputs.update-type != 'version-update:semver-major'
        run: gh pr merge --auto --squash "$PR_URL"
        env:
          PR_URL: ${{ github.event.pull_request.html_url }}
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

マージは必須チェックの通過後にのみ行われるため、安全性を担保するのはブランチ保護と信頼できるテストです。リポジトリ設定で「Allow auto-merge」を有効にしてください。GitHub Actionsのセキュリティ確保で説明しているとおり、dependabot/fetch-metadataはSHAにピン留めしてください。信頼できるテストカバレッジがない限り、本番環境の依存関係に関わるものは決して自動マージしないでください。

GitHub Actionsをピン留めして更新し続ける

上記のようにgithub-actionsエコシステムを追加します。Dependabotはタグ形式とSHAピン留めの両方の参照を更新します。SHAピン留めの場合は、末尾の# v3.5.2コメントも正確に保たれます。これにより、保守の負担を増やさずにSHAでピン留めできます。

振り分けと担当者

PRには担当者が必要です。そうしないと誰も見ません。dependabot.ymlの非推奨のreviewersおよびassigneesオプションの代わりに、CODEOWNERSを使ってチームをレビュー依頼先にし、ラベルで絞り込みます。「依存関係の担当者」の役割を週ごとに交代させ、簡単なルールを決めてください。グリーンのパッチ更新はその日のうちにマージし、メジャー更新はスケジュールに組み込みます。

モノレポと複数ディレクトリ

Dependabotは、エコシステムとディレクトリごとに1つのupdatesエントリを必要とします。多数のディレクトリがある場合は、directories(リストまたはglob)を使うと、ブロックの繰り返しを避けられます:

- package-ecosystem: "npm"
  directories: ["/", "/apps/*", "/packages/*"]
  schedule:
    interval: "weekly"

そのうえで、同じ依存関係が更新されるディレクトリ間で、グループが更新をまとめます。複数ディレクトリのグループがどのように作られるかは、お使いのバージョンのDependabotドキュメントで確認してください。

よくある質問

Dependabot のPRはいくつまでが多すぎますか?

PRが1週間以上開いたままになるなら、多すぎます。スケジュールを絞り、グループ化を増やし、無視するエコシステムを減らしてください。

Dependabotに費用はかかりますか?

Dependabot自体は無料です。ただし、そのPRはCIを実行するため、Actionsの分を消費します。

代わりにRenovateを使うべきですか?

Renovateは設定オプションが多く、複数のプラットフォームで動作します。Dependabotは GitHubに組み込まれており、ホスティングは不要です。どちらもグループ化とスケジュールに対応しており、必要な機能で選んでください。

しばらくの間、特定の更新を無視できますか?

はい、@dependabot ignore this minor versionとコメントするか、ignoreエントリーを使用できます。またはcooldownを使って、すべての更新頻度を下げることもできます。

CIを高速化すると、依存関係のPRを処理する際のコストを抑えられます。compiler.devの比較モードでは、より高速なランナーでテストワークフローを実行した場合のコストを確認できます。自動生成されるPRを多く受け取る場合に役立ちます。

このワークフローを compiler.dev で実行する カード登録不要 · 200 無料分

無料で試す