feat(ci): add CHANGELOG and exports map completeness gates by diberry · Pull Request #673 · bradygaster/squad

diberry · 2026-03-28T23:40:59Z

Part 2 of 2: PR Completeness Gates (Repo Health)

What

Adds two automated CI enforcement gates to squad-ci.yml:

CHANGELOG gate -- If a PR changes files in packages/squad-sdk/src/ or packages/squad-cli/src/, the CI requires CHANGELOG.md to also appear in the diff. Prevents SDK/CLI changes from shipping without changelog documentation.
Exports map check -- A new script (scripts/check-exports-map.mjs) reads all src/*/index.ts barrel files in squad-sdk and verifies each has a corresponding entry in package.json exports. Catches missing subpath exports before they cause consumer import failures.

Why

Part 1 (PR #108 / upstream #672) added PR_REQUIREMENTS.md and PULL_REQUEST_TEMPLATE.md to document what a complete PR looks like. Part 2 enforces two of those requirements with automated CI checks that give immediate feedback rather than relying on human reviewers to catch missing entries.

How

Both gates are implemented as separate jobs in squad-ci.yml (run in parallel with existing jobs)
Both are feature-flagged: disabled when vars.SQUAD_CHANGELOG_CHECK or vars.SQUAD_EXPORTS_CHECK is set to false (enabled by default)
Both support per-PR skip labels: skip-changelog and skip-exports-check
The CHANGELOG gate only applies when SDK/CLI source files are in the diff
The exports check only applies when SDK source files are in the diff
check-exports-map.mjs uses only Node.js built-ins (fs, path) -- zero dependencies

Related Issues

Refs Merge .ai-team-templates/ into .squad/templates/ #104 (PR completeness gates)
Part 1: PR Privacy: Scrub email addresses from .squad/ files during migration #108 (PR_REQUIREMENTS.md + PULL_REQUEST_TEMPLATE.md)
Refs Workflow dual-path support for .squad/ migration #103 (repo health tracking)

Testing

scripts/check-exports-map.mjs tested locally -- correctly identifies 5 barrel directories (platform, remote, roles, streams, upstream) that exist in src/*/index.ts but lack package.json export entries
Build passes: npm run build succeeds
Tests pass: 179/183 test files pass (5024 tests), 4 pre-existing integration test failures unrelated to this change (aspire-integration, cli-packaging-smoke, human-journeys, speed-gates)

Preflight

npm run build -- passes
npm test -- passes (183 suites, 5024 tests passed, 117s runtime; 4 pre-existing integration failures)

Breaking Changes

None. Both gates are additive CI jobs and do not affect existing jobs.

Waivers

None required. Feature flags and skip labels provide escape hatches for all gates.

Part 2 of 2 for repo health. Adds two automated CI enforcement gates to squad-ci.yml: 1. CHANGELOG gate -- requires CHANGELOG.md update when SDK/CLI source changes 2. Exports map check -- verifies package.json exports match barrel files Both feature-flagged (vars.SQUAD_CHANGELOG_CHECK, vars.SQUAD_EXPORTS_CHECK) with skip labels. Includes test coverage for check-exports-map.mjs. Refs #104 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Adds CI enforcement gates to ensure PR completeness for SDK/CLI changes by requiring changelog updates and validating @bradygaster/squad-sdk subpath exports against src/*/index.ts barrel directories.

Changes:

Adds a changelog-gate job to require CHANGELOG.md updates when SDK/CLI source files change (with feature flag + skip label).
Adds an exports-map-check job plus scripts/check-exports-map.mjs to detect missing package.json exports entries for SDK barrel directories (with feature flag + skip label).
Adds a Vitest test that executes the new exports-map checker script and validates its structured output.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.

File	Description
`test/check-exports-map.test.ts`	Adds a smoke test ensuring the exports-map checker script runs and emits expected output.
`scripts/check-exports-map.mjs`	Implements the exports-vs-barrel-directory completeness check for `packages/squad-sdk`.
`.github/workflows/squad-ci.yml`	Adds two new CI jobs (changelog gate + exports map check) with feature flags and skip-label escape hatches.

.github/workflows/squad-ci.yml

…missions - Fix runScript() to reject on spawn errors instead of masking as exit code 1 - Replace gh pr view label checks with github.event payload labels - Eliminates need for pull-requests: read permission Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

diberry · 2026-03-29T00:13:32Z

@bradygaster -- Same as #672 -- I'm iterating on how Squad interacts with Copilot code review. Most of Copilot's suggestions and comments resulted in changes to this PR. This is Part 2 of the repo health work (CI completeness gates). CI is green and ready to merge when you are.

bradygaster · 2026-03-29T01:24:19Z

so @diberry this is ready to merge? seems it has some opens

Remove changelog-gate and exports-map-check from this PR's diff. Those gates are in PR bradygaster#673. This PR should only add samples-build. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

.github/workflows/squad-ci.yml

test/check-exports-map.test.ts

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

diberry · 2026-03-29T02:29:09Z

@copilot apply changes based on the comments in this thread

- Replace substring-based label checks (contains+join) with exact match (contains on labels.*.name) for skip-changelog and skip-exports-check labels - Refactor check-exports-map tests to run script once in beforeAll Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

diberry · 2026-03-29T02:32:13Z

Fixed all 4 Copilot review findings:

skip-changelog: switched from substring to exact label match (accepted suggestion verbatim)
2-3. skip-exports-check: same fix applied to both step conditions
test/check-exports-map.test.ts: refactored to run script once in beforeAll

Copilot

Pull request overview

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

test/check-exports-map.test.ts

scripts/check-exports-map.mjs

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

readdirSync() ordering varies across platforms. Sort the list so missing-barrel reports are stable and diffable. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

diberry · 2026-03-29T02:38:37Z

Fixed -- added .sort() to barrelDirs for deterministic CI output across platforms.

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

diberry · 2026-03-29T02:43:47Z

@bradygaster Copilot is happy.

…eed heuristic - Fix sample count: 11 → 9 (actual count in samples/ directory) - Mark samples-build and changelog/exports gates as pending merge (#673, #674) - Add concrete heuristic for bleed check (scope by packages/ directory) - Clarify bash snippet as reference commands, not literal agent execution Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Remove changelog-gate and exports-map-check from this PR's diff. Those gates are in PR bradygaster#673. This PR should only add samples-build. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings March 28, 2026 23:41

Copilot started reviewing on behalf of diberry March 28, 2026 23:41 View session

diberry marked this pull request as draft March 28, 2026 23:42

Copilot AI reviewed Mar 28, 2026

View reviewed changes

diberry marked this pull request as ready for review March 29, 2026 00:09

diberry mentioned this pull request Mar 29, 2026

Squad product: PR completeness gates -- prevent merging without docs, CHANGELOG, exports, and samples CI diberry/squad#104

Open

7 tasks

diberry mentioned this pull request Mar 29, 2026

feat(ci): add samples build validation gate #674

Merged

2 tasks

diberry requested a review from Copilot March 29, 2026 02:25

Copilot started reviewing on behalf of diberry March 29, 2026 02:25 View session

Copilot AI reviewed Mar 29, 2026

View reviewed changes

.github/workflows/squad-ci.yml Outdated Show resolved Hide resolved

.github/workflows/squad-ci.yml Show resolved Hide resolved

.github/workflows/squad-ci.yml Show resolved Hide resolved

test/check-exports-map.test.ts Outdated Show resolved Hide resolved

Update .github/workflows/squad-ci.yml

78749c5

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

diberry requested a review from Copilot March 29, 2026 02:33

Copilot started reviewing on behalf of diberry March 29, 2026 02:33 View session

Copilot AI reviewed Mar 29, 2026

View reviewed changes

test/check-exports-map.test.ts Outdated Show resolved Hide resolved

test/check-exports-map.test.ts Outdated Show resolved Hide resolved

scripts/check-exports-map.mjs Outdated Show resolved Hide resolved

diberry and others added 3 commits March 28, 2026 19:36

Update test/check-exports-map.test.ts

5350804

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

Update test/check-exports-map.test.ts

29aeb84

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

fix: sort barrelDirs for deterministic CI output

37ce2ef

readdirSync() ordering varies across platforms. Sort the list so missing-barrel reports are stable and diffable. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

diberry requested a review from Copilot March 29, 2026 02:40

Copilot started reviewing on behalf of diberry March 29, 2026 02:40 View session

Copilot AI reviewed Mar 29, 2026

View reviewed changes

diberry and others added 2 commits March 28, 2026 21:25

Merge branch 'dev' into squad/104-pr-completeness-gates-upstream

e8d1796

Merge branch 'dev' into squad/104-pr-completeness-gates-upstream

7629e8a

tamirdresher merged commit 8abd106 into bradygaster:dev Mar 29, 2026
5 checks passed

Conversation

diberry commented Mar 28, 2026

Part 2 of 2: PR Completeness Gates (Repo Health)

What

Why

How

Related Issues

Testing

Preflight

Breaking Changes

Waivers

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!

diberry commented Mar 29, 2026

Uh oh!

bradygaster commented Mar 29, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

diberry commented Mar 29, 2026

Uh oh!

diberry commented Mar 29, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

diberry commented Mar 29, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

diberry commented Mar 29, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants