Skip to content

ci: fail the pull request whose changeset would generate an unformatted changelog - #54

Merged
bendersej merged 3 commits into
mainfrom
fix-web-changelog-format
Sep 28, 2026
Merged

bendersej merged 3 commits into
mainfrom
fix-web-changelog-format

Conversation

@bendersej

@bendersej bendersej commented Sep 28, 2026 •

Copy link
Copy Markdown
Member

Background

The version PR #53 failed Web / Formatting: the 1.9.0 changeset has a blank line between its lead paragraph and its list, which changeset version turns into a blank line inside a list item that Prettier rejects. The failure only showed in the version PR, after the feature PR had merged. The version PR should only ever contain generated output, never a formatting fix.

Changes

  • The root version script is a pure changeset version (no formatter), for every package.
  • New Changelog Check workflow on pull requests touching a package, a changeset or the root package.json: it runs the release's npm run version, then the formatting checks the version PR runs, so a changeset whose generated CHANGELOG is not formatted fails the pull request that adds it.
  • The pending 1.9.0 changeset: the blank line before its list is removed.

Notes

  • Verified locally with the pure version script: the original 1.9.0 changeset fails the check (as chore: version packages #53 did) and the fixed one passes.
  • Once merged, the release workflow rebuilds chore: version packages #53 from the fixed changeset, with nothing to reformat.

@bendersej
bendersej force-pushed the fix-web-changelog-format branch from ba5f666 to 6910522 Compare September 28, 2026 09:23
@bendersej bendersej changed the title chore: format web after changeset version, like react chore: format generated changelogs, and check them on every pull request Sep 28, 2026
…enerate an unformatted changelog fails its own pull request
@bendersej bendersej changed the title chore: format generated changelogs, and check them on every pull request ci: fail the pull request whose changeset would generate an unformatted changelog Sep 28, 2026
@bendersej
bendersej merged commit 2094988 into main Sep 28, 2026
3 checks passed
@bendersej
bendersej deleted the fix-web-changelog-format branch September 28, 2026 09:25
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