feat(ci): automated PR readiness checks — contributor feedback before review by diberry · Pull Request #752 · github/squad

diberry · 2026-04-02T17:44:05Z

What

Adds an automated PR readiness check system that posts a checklist comment on every PR, telling contributors exactly what needs fixing before review.

Closes #750

Why

Contributors open PRs that aren't review-ready (draft, unsquashed commits, stale branch, missing changeset, etc.). Brady has to manually check and comment on each one. This workflow automates that feedback loop — contributors get immediate, actionable guidance.

How

Approach: GitHub Action with PR comment (evaluated 3 approaches — see docs/proposals/pr-readiness-checks.md for full analysis).

Workflow (squad-pr-readiness.yml):

Runs on pull_request events (opened, synchronize, reopened, edited, ready_for_review)
Evaluates 7 readiness checks via GitHub API
Posts/updates a single checklist comment (no spam — uses HTML comment marker for upsert)
Informational only — does not block merge

7 Checks:

Single commit (or squashable)
Not in draft
Branch up to date with target
Copilot review present
Changeset present (respects skip-changelog label)
No merge conflicts
CI passing

Also includes:

Proposal doc at docs/proposals/pr-readiness-checks.md
Updated CONTRIBUTING.md with PR Readiness Checklist section
Changeset

Testing

Workflow validated via YAML syntax
npm run build passes
npm test passes

Docs

CONTRIBUTING.md updated with PR Readiness Checklist section
Proposal doc at docs/proposals/pr-readiness-checks.md

Exports

N/A — no SDK changes

Breaking Changes

None

Waivers

None needed

github-actions · 2026-04-02T17:44:20Z

🛫 PR Readiness Check

⚠️ 2 item(s) to address before review

Status	Check	Details
❌	Single commit (or squashable)	2 commits — consider squashing before review (or repo will squash on merge)
✅	Not in draft	Ready for review
✅	Branch up to date	Up to date with dev
❌	Copilot review	No Copilot review yet — it may still be processing
✅	Changeset present	Changeset file found
✅	No merge conflicts	No merge conflicts
✅	CI passing	No CI checks have run yet

This check runs automatically on every push. Fix any ❌ items and push again.
See CONTRIBUTING.md and PR Requirements for details.

Copilot

Pull request overview

Adds an automated “PR readiness” GitHub Action that posts/updates a single checklist comment on PRs, aiming to give contributors fast, actionable feedback before human review.

Changes:

Added a new workflow (squad-pr-readiness.yml) that evaluates PR readiness signals via GitHub API and upserts a checklist comment.
Documented the approach in a proposal doc and added a PR readiness section to CONTRIBUTING.
Added a Changesets entry (currently targeting @bradygaster/squad-cli).

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 12 comments.

File	Description
`docs/proposals/pr-readiness-checks.md`	Proposal documenting rationale/approach and intended behavior of readiness checks.
`CONTRIBUTING.md`	Adds contributor-facing PR readiness checklist section.
`.github/workflows/squad-pr-readiness.yml`	Implements the readiness checks and PR comment upsert workflow.
`.changeset/pr-readiness-checks.md`	Declares a package version bump related to this change.

Address all 12 Copilot review comments on PR #752: - Add issues: write permission for comment upserts - Switch to pull_request_target with safety guards (no checkout) - Rename 'Single commit (or squashable)' to 'Single commit' - Fix reversed compareCommitsWithBasehead base/head order - Use latest review per user instead of find() for Copilot review - Accept CHANGELOG.md edits in changeset check (match changelog-gate) - Model CI pending/no-checks as not-passing (don't mark ready early) - Use absolute repo URLs instead of broken relative links - Add pagination via github.paginate for comments, commits, reviews, files - Remove unnecessary changeset (no CLI code changes) - Fix fork-safe claim in proposal docs - Remove unnecessary actions/checkout step Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Wraps checks.listForRef in github.paginate() to handle PRs with 100+ check runs, matching the pagination pattern already used for commits, reviews, files, and comments in the same workflow. Closes #752 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

tamirdresher · 2026-04-03T06:15:51Z

Really useful for Brady's workflow - automates all the 'is this PR ready?' feedback he gives manually today.

Two things before merge:

Needs squash - 10 commits is too many for this
Needs rebase on dev (behind)

One suggestion from looking at microsoft/aspire: they also have a pull_request_template.md with static checkboxes that contributors see at PR creation time. Your bot comment validates dynamically which is better, but having both layers would be nice - template gives the checklist upfront, bot validates it. Could be a quick follow-up.

Content-wise this is solid. Fix the above and it's good to go.

diberry · 2026-04-03T11:46:00Z

📁 Files in this PR

#	File	Status
1	`.github/workflows/squad-pr-readiness.yml`	Added
2	`CONTRIBUTING.md`	Modified
3	`scripts/pr-readiness.mjs`	Added
4	`test/pr-readiness.test.ts`	Added

4 files — 1 workflow, 1 script, 1 test, 1 doc update.

@tamirdresher

Adds .github/pull_request_template.md with static checkboxes that contributors see at PR creation time. Complements the dynamic PR readiness bot (squad-pr-readiness.yml) — template gives the checklist upfront, bot validates it after push. Suggested by @tamirdresher in PR github#752 review. Closes github#778 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Adds a GitHub Action that posts a readiness checklist comment on every PR, giving contributors immediate feedback on what needs fixing before review. 7 checks: single commit, not draft, branch up to date, Copilot review, changeset present, no merge conflicts, CI passing. Informational only. Includes extracted script (pr-readiness.mjs), tests, and CONTRIBUTING.md update. Closes #750 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

@tamirdresher

Adds .github/pull_request_template.md with static checkboxes that contributors see at PR creation time. Complements the dynamic PR readiness bot (squad-pr-readiness.yml) — template gives the checklist upfront, bot validates it after push. Suggested by @tamirdresher in PR github#752 review. Closes github#778 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

@tamirdresher

Adds .github/pull_request_template.md with static checkboxes that contributors see at PR creation time. Complements the dynamic PR readiness bot (squad-pr-readiness.yml) — template gives the checklist upfront, bot validates it after push. Suggested by @tamirdresher in PR #752 review. Closes #778 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Adds a GitHub Action that posts a readiness checklist comment on every PR, giving contributors immediate feedback on what needs fixing before review. 7 checks: single commit, not draft, branch up to date, Copilot review, changeset present, no merge conflicts, CI passing. Informational only. Includes extracted script (pr-readiness.mjs), tests, and CONTRIBUTING.md update. Closes #750 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings April 2, 2026 17:44

Copilot started reviewing on behalf of diberry April 2, 2026 17:44

View session

Copilot AI reviewed Apr 2, 2026

View reviewed changes

diberry added a commit that referenced this pull request Apr 2, 2026

docs: update Booster history with PR #752 pagination fix

1854861

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

diberry added a commit that referenced this pull request Apr 2, 2026

docs: update Booster history with PR #752 pagination fix

3084dcd

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

This was referenced Apr 2, 2026

docs: document changeset branch hygiene — prevent cross-PR changeset leaks #754

Closed

ci: extract inline scripts from all workflows into standalone testable files #755

Closed

diberry force-pushed the squad/750-pr-readiness-checks branch from a00c9b7 to 1c3f963 Compare April 3, 2026 11:49

diberry mentioned this pull request Apr 3, 2026

feat(ci): add pull_request_template.md with contributor checklist #778

Closed

diberry mentioned this pull request Apr 3, 2026

feat(ci): add pull request template with contributor checklist #779

Merged

diberry force-pushed the squad/750-pr-readiness-checks branch from 4346d79 to e468222 Compare April 3, 2026 13:29

diberry merged commit a8e2ccb into dev Apr 3, 2026
11 checks passed

bradygaster deleted the squad/750-pr-readiness-checks branch August 8, 2026 08:41

Navigation Menu

Repository navigation

feat(ci): automated PR readiness checks — contributor feedback before review - #752

feat(ci): automated PR readiness checks — contributor feedback before review#752
diberry merged 1 commit into
devfrom
squad/750-pr-readiness-checks

diberry commented Apr 2, 2026

Uh oh!

github-actions Bot commented Apr 2, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tamirdresher commented Apr 3, 2026

Uh oh!

diberry commented Apr 3, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

diberry commented Apr 2, 2026

What

Why

How

Testing

Docs

Exports

Breaking Changes

Waivers

Uh oh!

github-actions Bot commented Apr 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🛫 PR Readiness Check

⚠️ 2 item(s) to address before review

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tamirdresher commented Apr 3, 2026

Uh oh!

diberry commented Apr 3, 2026

📁 Files in this PR

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented Apr 2, 2026 •

edited

Loading