Single-source codegen freshness checks via pnpm codegen scripts

[dmerand]

About this stack

This stack came out of reviewing recent contributor and agent sessions in Shopify/cli, where the same avoidable friction kept recurring: failures found only after pushing, generated files regenerated by hand, local checks drifting from what CI actually enforces, and setup conventions relearned every time. The goal is to make the local dev loop mirror CI and keep the two single-sourced so they can't drift — then document it so people and agents stop rediscovering it.

---

WHY are these changes introduced?

Two of our PR checks — Check graphql-codegen has been run and Check OCLIF manifests & readme & docs — spell out their regenerate-and-verify steps right inside tests-pr.yml. There's no local command that does the same thing, so the usual way you learn a generated file is stale is by watching CI go red. Then you re-run refresh-manifests, graphql-codegen, and build-dev-docs one at a time and push again. In effect the "what to regenerate" list lives in two heads — the workflow's and yours — and they drift.

WHAT is this pull request doing?

Making package.json the one place that defines codegen freshness, for people and CI alike:

• pnpm codegen regenerates everything.
• pnpm codegen:check:graphql / :oclif regenerate, then check the tree came back clean.

bin/check-codegen-clean.js owns each check's paths and the message you see when it fails (now pointing you at pnpm codegen). The two gate jobs simply call these scripts instead of repeating the steps inline.

It's deliberately a no-op in behavior — same generators, same order, same messages — and the job names, runners, and the oclif build step are untouched, so required checks and the merge queue don't notice the difference. Dev tooling only, nothing user-facing.

How to test your changes?

1. On a clean checkout, pnpm codegen should produce no diff (it's idempotent).
2. Add a flag without refreshing, then run pnpm codegen:check:oclif — it fails and points you at pnpm codegen; running that puts you back to clean.
3. The two gate jobs pass and fail exactly as they did before.

Notes

• There's intentionally no combined codegen:check: the whole-repo git status checks step on each other in a single working tree, which is why CI keeps them as separate, fresh-checkout jobs.
• Heads-up: pnpm codegen isn't quite idempotent on main today — it drops some orphaned config:autoupgrade docs that the OCLIF gate doesn't watch (it only checks generated/*.json). That's pre-existing and worth a separate fix.

Post-release steps

None.

[dmerand]

• Document pre-submit workflow and local dev (AGENTS.md + docs/LOCAL_DEV.md) #7734
• Add pnpm pre-ci:affected for a fast, diff-scoped pre-push check #7751
• Add pnpm pre-ci mirroring PR CI gates, with manifest drift guard #7733
• Single-source codegen freshness checks via pnpm codegen scripts #7732 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[Copilot]

Pull request overview

This PR centralizes “codegen freshness” (regenerate + verify working tree is clean) into pnpm scripts so local developer workflows and CI enforce the same steps without duplicating logic in GitHub Actions.

Changes:

• Adds pnpm codegen plus two CI-aligned check scripts: pnpm codegen:check:graphql and pnpm codegen:check:oclif.
• Introduces bin/check-codegen-clean.js as the single source of truth for per-check pathspecs and failure messaging.
• Updates tests-pr.yml to call the new pnpm codegen:check:* scripts instead of inlining regenerate-and-verify shell steps.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.

File	Description
package.json	Adds codegen and codegen:check:* scripts to standardize regeneration and cleanliness checks.
bin/check-codegen-clean.js	New helper script to assert codegen-owned paths are clean and emit a consistent remediation message/diff.
.github/workflows/tests-pr.yml	Simplifies CI gate jobs by invoking the new pnpm codegen:check:* scripts.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.