diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6422291582..27311ea9fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,17 @@ This project uses [Changesets](https://github.com/changesets/changesets) to mana pnpm changeset add ``` +## Generated freshness checks + +Before pushing changes that touch GraphQL operations, command definitions, flags, autogenerated examples, or CLI +documentation, run: + +``` +pnpm generate:all +``` + +This runs all generators checked by `.github/workflows/tests-pr.yml`. Commit any generated file changes before pushing. + ### Choosing the right bump type The CLI follows [semantic versioning](https://semver.org). Pick the bump type that matches the nature of your change: diff --git a/package.json b/package.json index 942408f5f8..ccdb6335a6 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "test": "pnpm vitest run", "type-check:affected": "nx affected --target=type-check", "type-check": "nx run-many --target=type-check --all --skip-nx-cache", - "update-bugsnag": "bin/update-bugsnag.js" + "update-bugsnag": "bin/update-bugsnag.js", + "generate:all": "pnpm graphql-codegen:get-graphql-schemas && pnpm graphql-codegen && pnpm build --output-style=stream && pnpm refresh-manifests && pnpm refresh-readme && pnpm refresh-code-documentation && pnpm build-dev-docs" }, "devDependencies": { "@bugsnag/source-maps": "^2.3.1",