できない.dev

GitHub Dependabot が PR を作成しない / 動かない

Dependabot が PR を作らないときは、Insights → Dependency graph → Dependabot のログで原因を確かめる。
多いのは YAML の構文ミス、機能の無効、PR 上限、ecosystem 名の誤りだ。

公開: 更新:

要約

Dependabot が PR を作らないときは、YAML 構文 → 機能の有効化 → PR 上限 → ecosystem 名 の順で切り分ける。
Insights → Dependency graph → Dependabot タブにエラー理由が出るので、勘で直す前にまずログを読む。

解決策

1. ログを確認する

GitHub の Insights → Dependency graph → Dependabot タブに各 ecosystem ごとの最終実行結果が出る。
エラーがあればここに表示される。

2. 最小構成で書き直す

# .github/dependabot.yml
version: 2
updates:
  - package-ecosystem: "npm"
    directory: "/"
    schedule:
      interval: "weekly"
    open-pull-requests-limit: 10

package-ecosystem の正しい値は公式の Configuration options(新しいタブで開く)に列挙されている。

3. 機能を有効化する

Settings を開き、サイドバーの「Security and quality」にある「Advanced Security」→ Dependabot の「Dependabot version updates」を Enable に切り替える。
項目自体が出ない場合は、オーガニゼーション側のポリシーで無効化されている可能性がある。
version updates の概観は、公式の Dependabot version updates(新しいタブで開く)にまとまっている。

4. 上限を引き上げて既存 PR を整理する

open-pull-requests-limit: 10

既存の Dependabot PR を @dependabot rebase で更新するか、マージ / クローズして空きを作る。

5. private registry の認証を追加

registries:
  npm-github:
    type: npm-registry
    url: https://npm.pkg.github.com
    token: ${{secrets.GH_PACKAGES_TOKEN}}
 
updates:
  - package-ecosystem: "npm"
    directory: "/"
    registries:
      - npm-github
    schedule:
      interval: "weekly"

token は repo / org の Dependabot secrets として登録する(Actions Secrets とは別枠)。

よくある原因

  1. YAML が壊れている。
    タブ混在 / インデントずれ / 未クォートのコロンで解析に失敗すると、設定はサイレントに無効化される。
  2. 機能が無効になっている。
    リポジトリ設定で、Dependabot version updates 自体が OFF になっている。
  3. PR の上限に達している。
    open-pull-requests-limit のデフォルト 5 に達すると、新規アップデートがあっても PR は作成されない。
  4. ecosystem 名を誤っている。
    npm を node、pip を python などと書いて、対象外になっている。
  5. private registry の認証が無い。
    認証 token を registries: に書いていないと、private パッケージは更新対象外になる。