mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-25 17:45:53 +01:00
fix(ci): unstick the lockfile refresh PR's required checks
The lockfile-policy design lets manifest-only PRs merge green against a regenerated lockfile artifact, with refresh-lockfile.yml expected to land the real lockfile right after via an auto-merge PR. That last step was permanently stuck: the branch is pushed with the default GITHUB_TOKEN, which triggers no pull_request workflows, so the required checks never start, auto-merge never fires, and every frozen-lockfile install on master fails until a human notices and pokes the PR — which is exactly what happened after #12095/#12100 merged. Prefer a LOCKFILE_BOT_TOKEN secret (fine-grained PAT, contents + pull-requests write) on every credential surface so the push triggers checks and auto-merge completes unattended, and add a verification step that fails the refresh run loudly — with recovery instructions in the job summary — whenever the PR's required checks have not started. A wiring test pins both properties and the policy job runs it. Tested: node --test scripts/__tests__/refresh-lockfile-workflow.test.mjs (3 pass); both workflow files re-parsed as YAML.
This commit is contained in:
1 parent
b76e36d6cf
commit
cbe91aab12
3 files changed
+99
-2
No files matched your search
@@ -69,6 +69,9 @@ jobs:
|
||||
- name: Test release verify workflow wiring
|
||||
run: node --test ./scripts/__tests__/release-verify-workflow.test.mjs
|
||||
|
||||
- name: Test lockfile refresh workflow wiring
|
||||
run: node --test ./scripts/__tests__/refresh-lockfile-workflow.test.mjs
|
||||
|
||||
- name: Test standalone package build concurrency
|
||||
run: node --test ./scripts/__tests__/build-standalone-concurrency.test.mjs
|
||||
|
||||
|
||||
@@ -21,6 +21,16 @@ jobs:
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v7
|
||||
with:
|
||||
# A branch pushed with the default GITHUB_TOKEN triggers no
|
||||
# pull_request workflows, so the lockfile PR's required checks
|
||||
# never start and the auto-merge below waits forever with master
|
||||
# desynced. Prefer a bot credential that does trigger workflows:
|
||||
# a fine-grained PAT with contents + pull-requests write, stored
|
||||
# as the LOCKFILE_BOT_TOKEN secret. Falls back to GITHUB_TOKEN,
|
||||
# in which case the verification step below fails loudly instead
|
||||
# of leaving the PR silently stuck.
|
||||
token: ${{ secrets.LOCKFILE_BOT_TOKEN || github.token }}
|
||||
|
||||
- name: Setup pnpm
|
||||
uses: pnpm/action-setup@v6
|
||||
@@ -53,7 +63,7 @@ jobs:
|
||||
- name: Create or update pull request
|
||||
id: upsert-pr
|
||||
env:
|
||||
GH_TOKEN: ${{ github.token }}
|
||||
GH_TOKEN: ${{ secrets.LOCKFILE_BOT_TOKEN || github.token }}
|
||||
REPO_OWNER: ${{ github.repository_owner }}
|
||||
run: |
|
||||
if git diff --quiet -- pnpm-lock.yaml; then
|
||||
@@ -91,6 +101,46 @@ jobs:
|
||||
- name: Enable auto-merge for lockfile PR
|
||||
if: steps.upsert-pr.outputs.pr_url != ''
|
||||
env:
|
||||
GH_TOKEN: ${{ github.token }}
|
||||
GH_TOKEN: ${{ secrets.LOCKFILE_BOT_TOKEN || github.token }}
|
||||
run: |
|
||||
gh pr merge --auto --squash --delete-branch "${{ steps.upsert-pr.outputs.pr_url }}"
|
||||
|
||||
# Auto-merge only fires once the required checks report. If the push
|
||||
# above went out on the default GITHUB_TOKEN, they never start: the
|
||||
# PR sits BLOCKED while every frozen-lockfile install on master keeps
|
||||
# failing. Turn that silent stall into a red run with instructions.
|
||||
- name: Verify required checks started on the lockfile PR
|
||||
if: steps.upsert-pr.outputs.pr_url != ''
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.LOCKFILE_BOT_TOKEN || github.token }}
|
||||
PR_URL: ${{ steps.upsert-pr.outputs.pr_url }}
|
||||
run: |
|
||||
head_sha="$(gh pr view "$PR_URL" --json headRefOid --jq .headRefOid)"
|
||||
for attempt in 1 2 3 4; do
|
||||
sleep 45
|
||||
count="$(gh api "repos/${GITHUB_REPOSITORY}/commits/${head_sha}/check-runs" --jq .total_count)"
|
||||
echo "check runs on ${head_sha}: ${count} (attempt ${attempt})"
|
||||
if [ "${count:-0}" -ge 8 ]; then
|
||||
echo "Required checks are running; auto-merge will complete the refresh."
|
||||
exit 0
|
||||
fi
|
||||
done
|
||||
{
|
||||
echo "## Lockfile PR is stuck without required checks"
|
||||
echo ""
|
||||
echo "The push used the default GITHUB_TOKEN, which does not trigger"
|
||||
echo "pull_request workflows, so ${PR_URL} cannot pass its required"
|
||||
echo "checks and auto-merge will never fire. Until it merges, every"
|
||||
echo "frozen-lockfile install on master fails."
|
||||
echo ""
|
||||
echo "Durable fix: create a fine-grained PAT (contents + pull-requests"
|
||||
echo "write on this repository) and store it as the LOCKFILE_BOT_TOKEN"
|
||||
echo "secret."
|
||||
echo ""
|
||||
echo "Immediate recovery (either works):"
|
||||
echo '- push an empty commit to chore/refresh-lockfile with any human'
|
||||
echo ' credential: git commit --allow-empty -m "chore: trigger checks"'
|
||||
echo "- or close and reopen the PR from a human account"
|
||||
} >> "$GITHUB_STEP_SUMMARY"
|
||||
echo "::error::Lockfile PR has no required checks running; see the job summary for recovery."
|
||||
exit 1
|
||||
@@ -0,0 +1,44 @@
|
||||
import assert from "node:assert/strict";
|
||||
import { readFileSync } from "node:fs";
|
||||
import path from "node:path";
|
||||
import { fileURLToPath } from "node:url";
|
||||
import test from "node:test";
|
||||
|
||||
const repoRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..", "..");
|
||||
const workflow = readFileSync(
|
||||
path.join(repoRoot, ".github/workflows/refresh-lockfile.yml"),
|
||||
"utf8"
|
||||
);
|
||||
|
||||
test("lockfile refresh pushes and manages its PR with a workflow-triggering credential", () => {
|
||||
// A push made with the default GITHUB_TOKEN triggers no pull_request
|
||||
// workflows, so the lockfile PR's required checks never start and
|
||||
// auto-merge waits forever while master's frozen installs keep failing.
|
||||
// Every credential surface must prefer the bot PAT and fall back to the
|
||||
// default token.
|
||||
const coalesce = /\$\{\{ secrets\.LOCKFILE_BOT_TOKEN \|\| github\.token \}\}/g;
|
||||
const occurrences = workflow.match(coalesce) ?? [];
|
||||
assert.ok(
|
||||
occurrences.length >= 4,
|
||||
`expected the LOCKFILE_BOT_TOKEN fallback on checkout, PR upsert, auto-merge, and verification (found ${occurrences.length})`
|
||||
);
|
||||
assert.doesNotMatch(
|
||||
workflow,
|
||||
/GH_TOKEN: \$\{\{ github\.token \}\}/,
|
||||
"no credential surface may use the bare default token"
|
||||
);
|
||||
});
|
||||
|
||||
test("a lockfile PR whose required checks never start fails the run loudly", () => {
|
||||
assert.match(workflow, /Verify required checks started on the lockfile PR/);
|
||||
assert.match(workflow, /check-runs/);
|
||||
assert.match(
|
||||
workflow,
|
||||
/::error::Lockfile PR has no required checks running/,
|
||||
"the stuck state must surface as a red run with recovery guidance"
|
||||
);
|
||||
});
|
||||
|
||||
test("auto-merge remains enabled so a green refresh lands without a human", () => {
|
||||
assert.match(workflow, /gh pr merge --auto --squash --delete-branch/);
|
||||
});
|
||||
Reference in new issue
Block a user