chore: mechanize pr readiness authoring #858
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: PR Check | |
| on: | |
| pull_request: | |
| branches: [ main, develop ] | |
| types: [opened, reopened, synchronize, edited, ready_for_review] | |
| jobs: | |
| quick-check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Check retro gate | |
| run: node scripts/check-retro-clean.js | |
| - name: Check PR readiness contract | |
| run: | | |
| node scripts/check-pr-readiness.js \ | |
| --base-sha "${{ github.event.pull_request.base.sha }}" \ | |
| --head-sha "${{ github.event.pull_request.head.sha }}" \ | |
| --event-path "$GITHUB_EVENT_PATH" | |
| - name: Setup pnpm | |
| uses: pnpm/action-setup@v4 | |
| with: | |
| run_install: false | |
| - name: Setup Node.js 20.x | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20.x | |
| cache: 'pnpm' | |
| - name: Install dependencies | |
| run: pnpm install --frozen-lockfile | |
| # PR checks stay on the main Node 20 lane so reviewers get one fast fail-fast signal. | |
| - name: Lint core package | |
| run: pnpm --filter "./packages/core" run lint | |
| - name: Build core package | |
| run: pnpm --filter "./packages/core" run build | |
| - name: Run unit tests (core) | |
| run: pnpm --filter "./packages/core" run test | |
| - name: Detect playground-impacting changes | |
| id: playground_changes | |
| shell: bash | |
| run: | | |
| base_sha="${{ github.event.pull_request.base.sha }}" | |
| head_sha="${{ github.event.pull_request.head.sha }}" | |
| changed_files=$(git diff --name-only "$base_sha...$head_sha") | |
| printf '%s\n' "$changed_files" | |
| if printf '%s\n' "$changed_files" | grep -Eq '^(packages/ztd-cli/|packages/test-evidence-core/|packages/test-evidence-renderer-md/|packages/testkit-core/|playgrounds/ztd-playground/|\.github/workflows/pr-check\.yml$)'; then | |
| echo "run=true" >> "$GITHUB_OUTPUT" | |
| else | |
| echo "run=false" >> "$GITHUB_OUTPUT" | |
| fi | |
| - name: Detect scaffold-layout changes | |
| id: generated_project_changes | |
| shell: bash | |
| run: | | |
| base_sha="${{ github.event.pull_request.base.sha }}" | |
| head_sha="${{ github.event.pull_request.head.sha }}" | |
| changed_files=$(git diff --name-only "$base_sha...$head_sha") | |
| printf '%s\n' "$changed_files" | |
| if printf '%s\n' "$changed_files" | grep -Eq '^(package\.json|scripts/verify-generated-project-mode\.mjs|packages/ztd-cli/package\.json|packages/ztd-cli/(README\.md|src/commands/(feature|init)\.ts|templates/|tests/(cliCommands|featureScaffold\.unit|init\.command)\.test\.ts)|docs/guide/(generated-project-verification|ztd-local-source-dogfooding|sql-first-end-to-end-tutorial)\.md|\.github/workflows/pr-check\.yml$)'; then | |
| echo "run=true" >> "$GITHUB_OUTPUT" | |
| else | |
| echo "run=false" >> "$GITHUB_OUTPUT" | |
| fi | |
| - name: Detect ztd-cli essential-gate changes | |
| id: ztd_cli_gates | |
| shell: bash | |
| run: | | |
| base_sha="${{ github.event.pull_request.base.sha }}" | |
| head_sha="${{ github.event.pull_request.head.sha }}" | |
| changed_files=$(git diff --name-only "$base_sha...$head_sha") | |
| printf '%s\n' "$changed_files" | |
| if printf '%s\n' "$changed_files" | grep -Eq '^(\.husky/pre-commit|\.github/pull_request_template\.md|\.github/workflows/pr-check\.yml|\.github/workflows/ztd-cli-soft-gates\.yml|scripts/(check-pr-readiness|run-ztd-cli-quality-gates|ztd-cli-quality-gates)\.js|docs/guide/(release-readiness|ztd-cli-quality-gates)\.md|packages/ztd-cli/|docs/guide/ztd-cli-)'; then | |
| echo "run=true" >> "$GITHUB_OUTPUT" | |
| else | |
| echo "run=false" >> "$GITHUB_OUTPUT" | |
| fi | |
| - name: Build ZTD CLI dependencies | |
| if: steps.playground_changes.outputs.run == 'true' | |
| run: | | |
| pnpm --filter rawsql-ts run build | |
| pnpm --filter @rawsql-ts/test-evidence-core run build | |
| pnpm --filter @rawsql-ts/test-evidence-renderer-md run build | |
| pnpm --filter @rawsql-ts/testkit-core run build | |
| pnpm --filter @rawsql-ts/ztd-cli run build | |
| - name: Detect deprecated playground | |
| id: playground | |
| if: steps.playground_changes.outputs.run == 'true' | |
| run: | | |
| if [ -d "./playgrounds/ztd-playground" ]; then | |
| echo "exists=true" >> "$GITHUB_OUTPUT" | |
| else | |
| echo "exists=false" >> "$GITHUB_OUTPUT" | |
| echo "playgrounds/ztd-playground is removed; skipping playground artifact generation." | |
| fi | |
| # Playground artifact generation stays in PR checks, but only when relevant packages or the workflow changed. | |
| - name: Generate ZTD artifacts (playground) | |
| if: steps.playground_changes.outputs.run == 'true' && steps.playground.outputs.exists == 'true' | |
| working-directory: ./playgrounds/ztd-playground | |
| run: node ../../packages/ztd-cli/dist/index.js ztd-config | |
| - name: Verify working tree is clean after generation | |
| if: steps.playground_changes.outputs.run == 'true' && steps.playground.outputs.exists == 'true' | |
| run: git diff --exit-code | |
| - name: Run generated-project verification lane | |
| if: steps.generated_project_changes.outputs.run == 'true' | |
| run: pnpm verify:generated-project-mode | |
| - name: Build ztd-cli gate dependencies | |
| if: steps.ztd_cli_gates.outputs.run == 'true' | |
| run: | | |
| pnpm --filter rawsql-ts run build | |
| pnpm --filter @rawsql-ts/sql-grep-core run build | |
| pnpm --filter @rawsql-ts/test-evidence-core run build | |
| pnpm --filter @rawsql-ts/test-evidence-renderer-md run build | |
| pnpm --filter @rawsql-ts/testkit-core run build | |
| - name: Run ztd-cli essential gates | |
| if: steps.ztd_cli_gates.outputs.run == 'true' | |
| run: node scripts/run-ztd-cli-quality-gates.js pr | |
| - name: Run parser benchmark (PR lightweight) | |
| run: pnpm run benchmark:parser:pr | |
| # Keep package validation lightweight in PRs; broader multi-version validation stays in push CI. | |
| - name: Check package.json validity | |
| run: | | |
| mkdir -p tmp | |
| pnpm pack --filter "./packages/core" --pack-destination ./tmp | |
| - name: Run unit tests (prisma-integration) | |
| run: echo "prisma-integration removed" | |
| - name: Check prisma-integration package | |
| run: echo "prisma-integration removed" |