Skip to content

ci(template): standardize ready pull request checks - #9

Merged
PerfectPan merged 1 commit into
mainfrom
ci/ready-pr-checks
Nov 3, 2026
Merged

PerfectPan merged 1 commit into
mainfrom
ci/ready-pr-checks

Conversation

@PerfectPan

@PerfectPan PerfectPan commented Nov 3, 2026 •

Copy link
Copy Markdown
Owner

Summary

Make the technology-agnostic CI example use one full-check policy: Ready pull requests run when opened, updated with new commits, reopened, or marked Ready; Draft pull requests skip the full job. Keep the existing main-push trigger and the lightweight Review workflow unchanged.

Document adoption expectations, including preserving project-specific manual triggers and release Draft flows, checking the actual executed job before merging, and keeping repository/title/body feedback available on Draft PRs. This is narrow maintenance of the workflow example and contribution policy; no separate design document is needed.

Validation

  • gh repo-checks repository and git diff --check passed.
  • actionlint 1.7.12 passed for .github/workflows/ci.yml.example and .github/workflows/review.yml.
  • A local matrix parsed the actual YAML and evaluated 35 event/Draft cases, including Ready creation/update/reopen/transition, Draft skipping, excluded metadata events, preserved main pushes, and the absence of a newly added manual trigger. It also verified unchanged Review content and full-CI steps. This is static configuration validation, not hosted event delivery.
  • PR title and description checks passed locally. Existing local hooks were preserved; relevant gates were run explicitly.
  • Hosted Review run 41606405764 passed on exact head 5aa0cb5e0acc927f60c33df247bddf3c9489aef2 while the PR remained Draft. The repository, title and description jobs all executed successfully. The CI example remains an inactive .example file with a placeholder command; this template has no real application suite, so no full-CI execution is claimed.

Risks

GitHub treats a skipped job as successful, even when it is required. Draft skipping must not be mistaken for executed tests: after marking a PR Ready, review successful full checks for the current comparison before merging. The active Review workflow remains available during Draft work.

Read-only inspection found no classic protection on main and one disabled ruleset; this change does not configure repository settings or enforce merge protection. Downstream projects must preserve their required check names and existing necessary push/manual triggers when adopting the example. No publishing, security configuration, or unrelated workflow changes are included.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant