日曜の朝6時すぎ、Dependabotの設定ファイルがmainに入った。2分後、PRが2本立った。1本は非majorの更新をまとめたもの。もう1本は、TypeScriptを5系から7系に上げるPRだった。
7系への更新は、7月にRenovateが出して、こちらが閉じたものだ。ビルドが通らず、Next.js側の対応待ちにした。Renovateはそれを律儀に覚えていて、以来4か月、7系のPRを一度も出さなかった。Dependabotはその約束を知らない。
なぜ2系統になっていたか
このrepoでは、記事も機能もdev → mainのPRで本番に出す。依存更新はRenovateが出していた。そこに、リポジトリ設定でオンにしたDependabot security updatesの脆弱性の修正PRが加わり、2系統になった。
Renovateの設定は、痛い目を見るたびに増えた(黙って止まった別の件は見張りを置いた話に書いた)。
- 入れた直後はパッケージごとにPRが立ち、1週間で数十本になった。PR 1本ごとにCIが回る。そこで非majorを1本にまとめ、同時に開くのは3本までにした
- 常時動かすと、nextもlucide-reactも、同じパッケージのPRが数日のうちに3本ずつ立った。そこで月曜の朝だけ動かし、リリースから3日待つようにした
- 既定ではmainに直接PRを出すので、devに戻らない。9月には、devのmermaidもvitestも本番よりmajorが1つ古いままだった。そこでdev向けにした
寄せる先は、脆弱性のPRを実際に出している方にした。Renovateの脆弱性のPRはタイトルに [SECURITY] が付くので gh pr list --author app/renovate --state all --search "SECURITY in:title" で拾え、Dependabotはdependabot.ymlが無いうちは出るPRが全部security updatesだ。どちらもDependabot alertsがオンでないと出ない。このrepoで出していたのはDependabotだけだった。
引き継いだもの、捨てたもの
| やりたいこと | Renovate | Dependabot | 判断 |
|---|---|---|---|
| devに向ける | baseBranchPatterns(旧 baseBranches) | target-branch: dev | 引き継ぐ |
| 月曜の朝だけ動かす | schedule | schedule(weekly・monday) | 引き継ぐ |
| リリースから3日待つ | minimumReleaseAge | cooldown | 引き継ぐ |
| 非majorを1本にまとめる | packageRules | groups | 引き継ぐ(repo全体で1本 → ecosystemごとに1本) |
| 同時に開くのは3本まで | prConcurrentLimit | open-pull-requests-limit | 引き継ぐ(repo全体 → ecosystemごと) |
| 自社製ツール1つだけ即時追従・自動マージ | packageRules | 自動マージの項目なし | 捨てる |
| CIのNodeの版を上げる | 更新対象に入る | 更新対象に入らない | 捨てる(手で上げる) |
| 更新の一覧をissueで見る | Dependency Dashboard | なし | 捨てる |
| 脆弱性のPRをdevに出す | vulnerabilityAlerts | できない | 捨てる(後述) |
引き継いだ設定は、npmの方だとこうなる。github-actionsにも同じentryを並べた。
version: 2
updates:
- package-ecosystem: npm
directory: /
target-branch: dev
schedule:
interval: weekly
day: monday
time: "03:00"
timezone: Asia/Tokyo
open-pull-requests-limit: 3
# リリース直後の版を掴まない。週次と合わせて、連続リリースを1本のPRに畳む
cooldown:
default-days: 3
groups:
npm-non-major:
patterns: ["*"]
update-types:
- minor
- patch
timezone を書き忘れると、time はUTCとして読まれ、日本の月曜昼12時に動く。
捨てたものは、代わりを作る手間が見合わなかった。自動マージはdependabot.ymlに項目が無く、GitHub Actionsでworkflowを組むことになる(公式の手順)。1パッケージのためにそこまではせず、週次のまとめPRに入れた。github-actionsの更新対象として公式の説明が挙げるのは uses: のアクションと再利用ワークフローだけで、node-version は入っていない。
脆弱性のPRはmain向きの1本になる
Renovateの vulnerabilityAlerts は、GitHubのDependabot alertsを読んで動く(Renovateのdocs)。このrepoではalertsがオフだったので、dev向けの脆弱性設定は読みに行くalertが無いまま待ちぼうけだった。alertsとsecurity updatesがオンになると、間接依存のalertがまとめて立ち、1〜2分でDependabotの修正PRがmainに来た。alertsが立ったのは移行の前日だった。
一本化すると、脆弱性の経路はこのmain向きの1本だけになる。公式docsは「security updates always use the default branch」と書いていて、target-branch もcooldownも効かない。修正を待たせないための仕様としては正しい。困るのは、mainにだけ入った package-lock.json の変更がdevに戻らず、次のdev → mainで衝突しうることだ。だから移行より先に、mainからdevへ戻す道を足した。
衝突したときは、pushせずに失敗させて人が直す。default branchをdevに変える手は、本番のデプロイとPRの流れがmain前提なので取らなかった。
移して初めて分かったもの
閉じたPRの記憶は移らない
Renovateは、majorのPRをmergeせずに閉じると、そのmajorを以後出さない(閉じたPRに「Renovate will ignore this update.」とコメントが付く)。この記憶はRenovate側にあり、移行で消える。冒頭のTypeScript 7は、こうして戻ってきた。
しかも戻ってきたPRのCIは緑だった。7月の「ビルドが通らない」は、4か月のうちに消えていたらしい。Renovateの記憶は、閉じた理由が消えたことまで隠していた。
移行の前に、そのコメントが付いたPRを棚卸ししておく。
gh pr list --author app/renovate --state closed --search "is:unmerged \"Renovate Ignore Notification\" in:comments"
それでも保留するなら、戻ってきたPRに @dependabot ignore this major version とコメントすれば、そのmajorは出なくなる(コメントコマンド一覧)。
初日だけ週次ではない
dependabot.ymlを足すと、その場で1回動く(現行のdocsも、ファイルが入るとすぐ依存を確かめに行くと書いている)。日曜の朝のまとめPRは、翌朝の定時実行が更新を1つ足した新しいPRに置き換えた。PR本数を絞るための設定が、初日だけ1本多くCIを回したことになる。次のrepoでは、月曜の定時実行のすぐ後に入れる。
設定ファイルは書ける。難しいのは周りの運用
dependabot.yml そのものは、上の表と見本があれば迷わずに書ける。移行で時間を取られたのは、設定ファイルの外にあるものだった。
| やること | 自分でできるか | うちで詰まったところ |
|---|---|---|
| Renovate の設定を dependabot.yml に移す | できる。表の「引き継ぐ」行をそのまま写す | timezone の書き忘れで動く時刻がずれる |
| 捨てる設定を決める | できる。理由ごと表にしてから消す | 自動マージを残すなら workflow を自作することになる |
| 閉じた major の PR を棚卸しする | できる。上の gh の 1 行で拾える | 閉じた理由がもう消えているかは、1 本ずつ CI を回さないと分からない |
| 脆弱性の PR が main にだけ入る問題 | dev → main の運用なら仕組みが要る | main から dev へ戻す道を、衝突時に止まる形で作る必要があった |
| 移行初日の PR と CI の本数 | 入れる時刻を選べば避けられる | 初日に 1 本多く CI を回した |
1〜3 行目は自分のチームで片付く。4 行目は、ブランチの運用ごと見直すことになるので、移行より先に手を付けておく。
まとめ
- 寄せる先は、脆弱性のPRを出している側にする(比べる前にDependabot alertsをオンにする)。security updatesはdefault branchにしか来ないので、dev → mainの運用ならmainからdevへ戻す道を先に用意する
- 設定は理由ごと移し、捨てるものは表にしてから消す。閉じたPRの記憶のように、設定ファイルに無いものも棚卸しする
- 設定は入れた直後に1回動く。初日のPRは、週次の約束の外にある
playpark では、依存更新の bot の整理と、dev → main のようなブランチ運用に合わせた GitHub Actions の組み直しを引き受けています。PR と CI の本数を減らしつつ、脆弱性の修正を待たせない形に揃えます。
相談するときは、使っている bot(Renovate / Dependabot / 両方)、ブランチの運用(main だけか、dev を挟むか)、週あたりの依存更新の PR のおおよその本数を書いてもらえると、最初の返信から具体的な案で話せます。



