Skip to content

feat(changelog): skip internal PRs, fold follow-up fixes, group related PRs #837

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adrians5j merged 2 commits into from
Oct 21, 2026
Merged

feat(changelog): skip internal PRs, fold follow-up fixes, group related PRs #837

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c03d081
feat(changelog): skip internal PRs and fold in-release follow-up fixes
adrians5j Oct 21, 2026
ce0709e
feat(changelog): group related PRs into a single entry
adrians5j Oct 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ When editing a generated `changelog.mdx` file, always keep the sibling `changelo

The `generate-changelog.ts` script reads `## Skipped PRs` to avoid re-adding manually removed entries on the next run. If `changelog.ai.txt` is not updated, removed PRs will reappear.

PRs for a release are discovered from the release commits (the `(#NNNN)` references between the previous release tag and this version's tag/branch), **not** from a GitHub milestone — so a forgotten milestone no longer drops entries. Run `yarn generate:changelog --version <v> --dry-run` to preview the PRs that would be included.
PRs for a release are discovered from the `X.Y.Z` GitHub milestone. PRs labeled `no-changelog` are left out. Run `yarn generate:changelog --version <v> --dry-run` to preview the PRs that would be included.

Before generating, the script triages the new PRs. Titles with a `ci`, `build` or `test` type, a `ci`, `build`, `release`, `e2e` or `test` scope, or a `chore: merge ...` title are dropped outright. A Claude call then flags the remaining internal PRs and finds follow-ups: fixes merged later in the same release for something a PR of that release introduced. A follow-up gets no entry. Its description goes to Claude as context for the entry of the PR it finishes. The same call also groups related PRs that deliver one change, for example the API and the Admin part of a feature; each group becomes a single entry with all its PRs linked in the heading. Every PR left out this way is appended to `## Skipped PRs` with the reason, so reruns stay stable. To bring one back, write its entry by hand. Deleting the line only gets the PR triaged again on the next run. With `CLAUDE_KEY` set, `--dry-run` runs the triage call too and prints what it would leave out.

**Upgrade guide custom steps:** `upgrade-guide.mdx` is regenerated from a template by the release workflows. Put release-specific steps between the `{/* custom-steps:start ... */}` and `{/* custom-steps:end */}` markers, before `<AdditionalNotes />`. `scripts/generate-upgrade-guide.ts` keeps that block and the page `id` on every run. Anything outside the markers is overwritten.

Expand Down
Loading