Files
PaperClipAI/.github/workflows/refresh-lockfile.yml
Devin Foley cbe91aab12 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.
2026-08-24 12:10:47 -07:00

147 lines
5.7 KiB
YAML

name: Refresh Lockfile
on:
push:
branches:
- master
workflow_dispatch:
concurrency:
group: refresh-lockfile-master
cancel-in-progress: false
jobs:
refresh:
runs-on: ubuntu-latest
timeout-minutes: 10
permissions:
contents: write
pull-requests: write
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
with:
version: 9.15.4
run_install: false
- name: Setup Node.js
uses: actions/setup-node@v7
with:
node-version: 24
cache: pnpm
- name: Refresh pnpm lockfile
run: pnpm install --lockfile-only --ignore-scripts --no-frozen-lockfile
- name: Fail on unexpected file changes
run: |
changed="$(git status --porcelain)"
if [ -z "$changed" ]; then
echo "Lockfile is already up to date."
exit 0
fi
if printf '%s\n' "$changed" | grep -Fvq ' pnpm-lock.yaml'; then
echo "Unexpected files changed during lockfile refresh:"
echo "$changed"
exit 1
fi
- name: Create or update pull request
id: upsert-pr
env:
GH_TOKEN: ${{ secrets.LOCKFILE_BOT_TOKEN || github.token }}
REPO_OWNER: ${{ github.repository_owner }}
run: |
if git diff --quiet -- pnpm-lock.yaml; then
echo "Lockfile unchanged, nothing to do."
echo "pr_url=" >> "$GITHUB_OUTPUT"
exit 0
fi
BRANCH="chore/refresh-lockfile"
git config user.name "lockfile-bot"
git config user.email "lockfile-bot@users.noreply.github.com"
git checkout -B "$BRANCH"
git add pnpm-lock.yaml
git commit -m "chore(lockfile): refresh pnpm-lock.yaml"
git push --force origin "$BRANCH"
# Only reuse an open PR from this repository owner, not a fork with the same branch name.
pr_url="$(
gh pr list --state open --head "$BRANCH" --json url,headRepositoryOwner \
--jq ".[] | select(.headRepositoryOwner.login == \"$REPO_OWNER\") | .url" |
head -n 1
)"
if [ -z "$pr_url" ]; then
pr_url="$(gh pr create \
--head "$BRANCH" \
--title "chore(lockfile): refresh pnpm-lock.yaml" \
--body "Auto-generated lockfile refresh after dependencies changed on master. This PR only updates pnpm-lock.yaml.")"
echo "Created new PR: $pr_url"
else
echo "PR already exists: $pr_url"
fi
echo "pr_url=$pr_url" >> "$GITHUB_OUTPUT"
- name: Enable auto-merge for lockfile PR
if: steps.upsert-pr.outputs.pr_url != ''
env:
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