Skip to content

fix: keep all of a PR's changesets in the release PR summary#4031

Merged
ericallam merged 1 commit into
mainfrom
fix/release-pr-summary-dedup
Jun 25, 2026
Merged

fix: keep all of a PR's changesets in the release PR summary#4031
ericallam merged 1 commit into
mainfrom
fix/release-pr-summary-dedup

Conversation

@ericallam

Copy link
Copy Markdown
Member

Summary

The auto-generated changeset release PR (changeset-release/main) builds its ## Improvements / ## Bug fixes summary with scripts/enhance-release-pr.mjs. The script deduplicated summary entries by PR number, so when a single PR shipped more than one changeset, only the first entry survived and the rest were silently dropped from the summary. The dropped entries still appeared in the raw <details> block, which is how the mismatch surfaced (for example in #3998, where one PR's four changesets showed up as a single summary line).

Fix

Deduplicate on the full entry text rather than the bare PR number. The entry text embeds the PR link, so:

  • the same changeset rendered once per package section still collapses to one,
  • distinct changesets from the same PR are each kept,
  • identical descriptions from different PRs stay separate.

Verified against the raw changeset output from #3998: that PR's changesets went from 1 to all 4 in the generated summary.

The changeset release PR summary deduplicated entries by PR number, so
a PR that ships more than one changeset had every entry after the first
dropped from the summary (they stayed only in the raw output). Key the
dedup on entry content instead, which keeps distinct changesets from the
same PR while still collapsing one changeset repeated across package
sections.
@changeset-bot

changeset-bot Bot commented Jun 25, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: dd5b161

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: e299c903-2568-44cb-85c6-fe1853903857

📥 Commits

Reviewing files that changed from the base of the PR and between 2fa84ea and dd5b161.

📒 Files selected for processing (1)
  • scripts/enhance-release-pr.mjs
📜 Recent review details
⏰ Context from checks skipped due to timeout. (3)
  • GitHub Check: audit
  • GitHub Check: audit
  • GitHub Check: typecheck / typecheck
🔇 Additional comments (1)
scripts/enhance-release-pr.mjs (1)

38-43: LGTM!

Also applies to: 99-105


Walkthrough

The release-PR enhancement script now deduplicates changeset entries by normalized full entry text instead of by the PR number from the header link. It reconstructs each list item’s text, normalizes whitespace for the dedupe key, and skips entries already seen. The related comments were updated to describe the new behavior.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description has a solid summary and fix section, but it misses most required template sections and the issue-closing line. Add the required template sections: Closes #, checklist, testing steps, changelog, and screenshots, or mark them N/A if not applicable.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main fix: preserving all changesets from a PR in the release summary.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/release-pr-summary-dedup

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint install failed: dependency version conflict. Check your lock file or package.json.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ericallam ericallam marked this pull request as ready for review June 25, 2026 08:11

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@ericallam ericallam merged commit 422d8da into main Jun 25, 2026
24 checks passed
@ericallam ericallam deleted the fix/release-pr-summary-dedup branch June 25, 2026 08:20
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.

2 participants