Repository navigation
Incorporate change-notes into CHANGELOG.md at release - #4201
mario-campos wants to merge 5 commits into
Conversation
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Changenote deletions are not committed and can occur before the changelog is successfully written.
Review effort: Balanced
Findings: 1
Open (1)
What changed in this PR
Automates incorporating unreleased changenotes into the changelog during release preparation.
Changes:
- Extracts reusable changenote transfer logic.
- Integrates changenote assembly into release branch preparation.
- Updates ESM entry-point detection.
| File | Description |
|---|---|
pr-checks/changenotes.mts |
Adds reusable changenote assembly and cleanup. |
pr-checks/update-release-branch.mts |
Runs assembly when updating the release changelog. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
c91d2d4 to
67ca508
Compare
67ca508 to
0f6901c
Compare
mbg
left a comment
There was a problem hiding this comment.
This basically LGTM. I'd say that we should hold off from merging this until the current CLI release has wrapped up though (including the CodeQL Action release that's part of that process) so that, if there is a problem with this, we don't accidentally throw a spanner into that process -- especially since we don't currently have any change notes.
Two things I'd like to see on top of what's here:
- A workflow (or check in an existing one) that runs for ordinary PRs (not release PRs) and which complains (but doesn't necessarily fail) if the PR changes
CHANGELOG.mddirectly. That can be an independent PR from this one. - It would be good to improve our test coverage here for this. I know that
changenotes.tshas its own ones that test the functions there, but it would be good to have something more end-to-end. Let's chat about how to best approach that.
| return ExitCode.Success; | ||
| } catch (e) { | ||
| console.error("Failed to assemble changenotes to 'CHANGELOG.md'", e); | ||
| } | ||
|
|

This PR automates the effective execution of
pr-checks/changenotes.mts assembleinto the update-release-branch process by refactoring the code to be importable, and then importing it intopr-checks/update-release-branch.ts.Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
Workflow types:
Products:
Environments:
How did/will you validate this change?
.test.tsfiles).pr-checks).If something goes wrong after this change is released, what are the mitigation and rollback strategies?
How will you know if something goes wrong after this change is released?
Are there any special considerations for merging or releasing this change?
Merge / deployment checklist