Dependabot が qs のセキュリティ更新を出してきた。変わるのは pnpm-lock.yaml の 4 行だけ。CI は緑で、夕方に merge した。続いて本番のデプロイの workflow も走り、こちらにも緑のチェックが付いた。
更新後の lockfile で作ったバックエンドのイメージが本番に出たのは、翌朝だった。backend の Dockerfile を書き換えた別のリリース(dev から main への merge)のデプロイに、たまたま乗って。夕方の緑のチェックは、何もデプロイしていなかった。あいだに挟まったもう 1 回のリリースも同じだった。
自社の SaaS である Shift Bud の monorepo での話だ。バックエンドは GitHub Actions で Docker イメージを作って Cloud Run に出し、関係ない変更でデプロイが走らないよう、変更のあったパスで起動を絞っている。その絞り方で何を見落としていたかと、足し忘れをテストで止めるまでを書く。
緑の run の中身は skipped だった
何もしなかった run を、job ごとの結果で開くとこうなる。
gh run view <run-id> --json conclusion,jobs \
--jq '"run: \(.conclusion)", (.jobs[] | "\(.conclusion)\t\(.name)")'
run: success
success check-changes
skipped deploy-staging
skipped deploy-production
変更判定の job はログに No backend changes detected と書いて正常に終わり、デプロイの job は条件を満たさず飛ばされた。job が skipped でも run 全体は success になる。一覧に並ぶのは緑のチェックだけで、失敗なら届く通知も来ない。
判定はフォルダで、イメージの材料は COPY で決まっていた
判定が見ていたのは 4 つだった。packages/backend/**、packages/shared/**、docker/Dockerfile.backend、workflow 自身。「backend に関係するフォルダ」としては、もっともらしい一覧だ。
ところがイメージの中身を決めるのはフォルダではなく、Dockerfile の COPY だ。
COPY package.json pnpm-lock.yaml pnpm-workspace.yaml tsconfig.json ./
COPY packages/backend ./packages/backend
COPY packages/shared ./packages/shared
COPY docker/entrypoint.backend.sh /app/entrypoint.sh
monorepo のルートにある lockfile やワークスペースの設定、起動スクリプトは、どのパッケージのフォルダにも属さない。依存の更新はたいてい lockfile だけを変えるので、ちょうどこの隙間に落ちる。
笑えないのは、同じフォルダにある CI の workflow には「ルートの設定を見落とすと CI が黙って飛ぶ」という趣旨のコメントがすでに書いてあったことだ。一度踏んで直した跡がある。デプロイの判定は、その隣のファイルで同じ穴を開けていた。
関門は 1 つではなかった
直しに入ると、パスで判定している場所が 3 つあった。staging と production で起動のしかたが違うからだ。
production は CI の完了を workflow_run で受けて起動するので、CI の起動条件がそのままデプロイの関門になる。同じパスの一覧が glob で 2 回、正規表現で 1 回書かれていて、どれか 1 つに足し忘れると、そのファイルだけの変更は staging か本番のどちらかに出ない。しかも、どこで止まるかで見え方が違う。
| そのファイルだけを変えたとき(直す前) | staging | production |
|---|---|---|
packages/backend/ の中 | デプロイされる | デプロイされる |
pnpm-lock.yaml | run が起動しない | run は緑、デプロイは skipped |
tsconfig.json(ルート) | run が起動しない | CI ごと起動しない |
いちばん質が悪いのは右下だ。run が無いので、緑のチェックすら残らない。CI の paths がデプロイの関門になることは、deploy の workflow をいくら読んでも書いていない。paths で CI の起動を絞ること自体の副作用は、GitHub Actions の無料枠の記事に書いた。
足すだけだと、次の COPY でまた起きる
足りない 5 つのパスを 3 か所に足せば、今回は直る。ただ、次に誰かが Dockerfile に COPY を 1 行足したとき、3 か所を思い出せる保証はない。そこで一覧どうしの関係をテストにした。Dockerfile が COPY するものは全てデプロイの起動条件にあり、デプロイの起動条件は全て CI の起動条件にある、の 2 本だ。2 本目は、本番が CI の完了を待つ構成のときだけ要る。
依存なしの Node で動く。ファイルのパスは自分の repo に合わせて書き換える。
// scripts/deploy-paths.test.mjs
import assert from 'node:assert/strict';
import { readFileSync } from 'node:fs';
import { test } from 'node:test';
const DOCKERFILE = 'docker/Dockerfile.backend';
const DEPLOY = '.github/workflows/deploy-backend.yml';
const CI = '.github/workflows/ci.yml';
// on.push.paths の項目を取り出す(YAML ライブラリを足さず、インデントで読む)
function pushPaths(file) {
const lines = readFileSync(file, 'utf8').split('\n');
const push = lines.indexOf(' push:');
const next = lines.findIndex((l, i) => i > push && /^ {0,2}\S/.test(l)); // push の次のキー
const start = lines.findIndex((l, i) => i > push && /^ {4}paths:/.test(l));
assert.ok(push !== -1 && start !== -1 && (next === -1 || start < next), `${file} に on.push.paths がない`);
const paths = [];
for (const line of lines.slice(start + 1)) {
const m = line.match(/^ {6}- ['"]?([^'"]+)['"]?\s*$/);
if (!m) break;
paths.push(m[1]);
}
return paths;
}
// build context から COPY する取り込み元(--from= は別 stage からなので除く)
function copySources() {
const sources = [];
for (const line of readFileSync(DOCKERFILE, 'utf8').split('\n')) {
if (!line.startsWith('COPY ') || line.includes('--from=')) continue;
const args = line.split(/\s+/).slice(1).filter((a) => !a.startsWith('--'));
sources.push(...args.slice(0, -1)); // 最後の引数はコピー先
}
return sources;
}
// paths の 1 項目が、そのファイルかディレクトリを含むか
const covers = (entry, path) =>
entry === path ||
(entry.endsWith('/**') && (path + '/').startsWith(entry.slice(0, -2)));
test('Dockerfile が COPY するものは、全てデプロイの起動条件にある', () => {
const deploy = pushPaths(DEPLOY);
assert.ok(copySources().length > 0, `${DOCKERFILE} から COPY を拾えない`);
for (const src of copySources()) {
assert.ok(deploy.some((e) => covers(e, src)), `${src} が ${DEPLOY} の paths にない`);
}
});
test('デプロイの起動条件は、全て CI の起動条件にもある', () => {
const ci = pushPaths(CI);
for (const path of pushPaths(DEPLOY)) {
assert.ok(ci.some((e) => covers(e, path)), `${path} が ${CI} の paths にない`);
}
});
ADD や行継続(\)、JSON 形式の COPY ["a", "b"] を使っている Dockerfile なら、そこも拾うように足す。COPY . . なら、.dockerignore で除いたもの以外すべてがイメージの材料なので、paths で絞る前提から見直す。
直す前のうちの Dockerfile と workflow で node --test scripts/deploy-paths.test.mjs を流すと、1 本目が package.json が .github/workflows/deploy-backend.yml の paths にない で落ちた。deploy の paths だけを直すと、今度は 2 本目が tsconfig.json が .github/workflows/ci.yml の paths にない で落ちる。1 つの穴を埋めると、隣の関門の穴が見える。3 か所とも直すと 2 本とも通り、そこへ COPY .npmrc ./ を 1 行足すと、1 本目がまた落ちる。
このテストは、Dockerfile と workflow の変更で必ず起動する CI に置く。テストを置いた CI が paths で飛んだら元も子もない。
載せた 2 本が守るのは glob で書いた 2 か所で、本番側の grep は別に照合する。うちは paths を正規表現に直して、grep と同じ集合かを確かめている。揃えてみると、既存の grep は末尾に $ が無く、paths より少し広く一致していた。2 か所に書いた一覧は、書いた日からずれ始める。
割り切ったことと、自分でやれる範囲
frontend だけの依存更新でも lockfile は変わるので、これからは backend もデプロイされる。lockfile を読んで「backend の依存が変わったときだけ」に絞る判定は作らなかった。余分なデプロイは数分で終わる。出し忘れは、緑のチェックの下で誰にも気付かれずに続く。
paths に COPY 元を足すことと、上のテストを置くことは、今日の作業で終わる。手間がかかるのは関門を全部見つけるほうで、workflow_run で別の workflow を待つ構成や、変更判定を action やスクリプトでもう一度書いている構成では、デプロイの workflow を読むだけでは見つからない関門がある。まずは lockfile だけを変えた直近の merge について、デプロイの run を探してみてほしい。run が無ければ [] が返る。
gh run list --workflow "<デプロイの workflow 名>" --commit <merge の SHA> --json databaseId,conclusion
見つかった run は、上の gh run view で開く。
まとめ
- デプロイ判定のパスは、フォルダではなく Dockerfile の
COPYから決める。lockfile・ルートの設定・起動スクリプトが漏れやすい - 本番が CI の完了を待つなら、CI の paths もデプロイの関門になる。skipped は緑の run に隠れるので、job 単位で見る
- 一覧を手で揃えず、「COPY の取り込み元 ⊆ デプロイの起動条件 ⊆ CI の起動条件」をテストで照合する
緑のチェックが言っていたのは「失敗しなかった」で、「何かした」ではなかった。Shift Bud のバックエンドは、いまは lockfile の 4 行でもデプロイされる。



