Add `changenotes.mts assemble` command to move changenotes to CHANGELOG.md by mario-campos · Pull Request #4155 · github/codeql-action · GitHub

This PR extends the pr-checks/changenotes.mts functionality by adding an assemble command that will be used to "flush" (or empty the contents of unreleased-change-notes) to the [UNRELEASED] section of CHANGELOG.md.

This PR also replaces the use of constants 0 and 1 for process exit codes with the ExitCode type from @actions/core.

Risk assessment

For internal use only. Please select the risk level of this change:

Low risk: Changes are fully under feature flags, or have been fully tested and validated in pre-production environments and are highly observable, or are documentation or test only.

Which use cases does this change impact?

Workflow types:

N/A

Products:

N/A

Environments:

Testing/None - This change does not impact any CodeQL workflows in production.

How did/will you validate this change?

Unit tests - I am depending on unit test coverage (i.e. tests in .test.ts files).

If something goes wrong after this change is released, what are the mitigation and rollback strategies?

Development/testing only - This change cannot cause any failures in production.

How will you know if something goes wrong after this change is released?

N/A

Are there any special considerations for merging or releasing this change?

No special considerations - This change can be merged at any time.

Merge / deployment checklist

Confirm this change is backwards compatible with existing workflows.
Consider adding a changelog entry for this change.
Confirm the readme and docs have been updated if necessary.

Changing `NO_CHANGES_STR` to just be the text will make it easier to insert/use. To not break anything, I added the deleted newlines to the locations where `NO_CHANGES_STR` was used.

Copilot review overview

🟡 Changes recommended

Empty or invalid inputs can mutate the changelog, and deletion failures can leave a partially completed flush.

Get a fresh assessment by requesting another Copilot review.

Review effort: Balanced
Findings: 3

Open (3)

Preserve the placeholder when there are no notes · New
Validate changenotes before deleting them · New
Avoid partial flushes when deletion fails · New

What changed in this PR

Adds a development command to move unreleased changenotes into CHANGELOG.md.

Changes:

Adds the changenotes.mts flush command.
Adds changelog insertion helpers and unit tests.
Normalizes the default no-changes placeholder.

File	Description
pr-checks/changenotes.mts	Implements changenote flushing and deletion.
pr-checks/changelog.ts	Adds unreleased-section insertion logic.
pr-checks/changelog.test.ts	Tests header parsing and insertion behavior.
pr-checks/bundle-changelog.test.ts	Updates assertions for the normalized placeholder.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Thanks for preparing this! I think functionally this looks fine, but as always, I have had a few comments and suggestions on the details of this initial implementation.

This will be used by the `pr-checks/changenotes.mts` script to "compile" the latest release entry of CHANGELOG.md.

This command will "flush" or move the changenotes in the `unreleased-change-notes` directory to the `[UNRELEASED]` section of the CHANGELOG.md file.

Thanks for addressing the feedback! This continues to look good in terms of functionality. I have a few more comments with minor suggestions and there was an inconsistency or two I spotted, but I don't think there's anything major that's blocking this, so I am happy to approve.

Co-authored-by: Michael B. Gale <mbg@github.com>

Thanks!

Do not include trailing newlines in NO_CHANGES_STR

cb31eab

Changing `NO_CHANGES_STR` to just be the text will make it easier to insert/use. To not break anything, I added the deleted newlines to the locations where `NO_CHANGES_STR` was used.

mario-campos requested a review from a team as a code owner September 18, 2026 14:42

Copilot AI balanced review requested due to automatic review settings September 18, 2026 14:42

Copilot started reviewing on behalf of mario-campos September 18, 2026 14:42 View session

github-actions Bot added the size/M Should be of average difficulty to review label Sep 18, 2026

Copilot AI reviewed Sep 18, 2026

View reviewed changes

Comment thread pr-checks/changelog.ts Outdated

Comment thread pr-checks/changenotes.mts Outdated

Comment thread pr-checks/changenotes.mts Outdated

mario-campos force-pushed the mario-campos/merge-changenotes branch from 36485ce to ff33914 Compare September 18, 2026 16:05

mbg reviewed Sep 18, 2026

View reviewed changes

mario-campos added 9 commits September 18, 2026 11:14

Add changelog parsing helper getHeader

47d607e

Add CHANGELOG function addBodyLinesToUnreleasedSection

bb1dc54

This will be used by the `pr-checks/changenotes.mts` script to "compile" the latest release entry of CHANGELOG.md.

Add changenotes.mts flush command

1ee3265

This command will "flush" or move the changenotes in the `unreleased-change-notes` directory to the `[UNRELEASED]` section of the CHANGELOG.md file.

Use withChangelog I/O helper

bffae1c

Use ExitCode instead of 0/1

b246e56

Assume '[UNRELEASED]' section is first section

d63b2a4

Simplify getHeader to operate on ChangelogSections

128614a

Simplify addBodyLinesToUnreleasedSection

bc0efd6

Replace splice with push and pop

977b29b

mario-campos force-pushed the mario-campos/merge-changenotes branch from ff33914 to 977b29b Compare September 18, 2026 18:47

mario-campos added 2 commits September 18, 2026 13:49

Rename flush command to assemble

7f54212

Refactor changenote file listing into function to D.R.Y.

a92f7fb

mario-campos mentioned this pull request Sep 18, 2026

Fix path-resolution bug in changenotes.mts validate by using getChangenotes #4156

Merged

mario-campos changed the title Add changenotes.mts flush command to move changenotes to CHANGELOG.md Add changenotes.mts assemble command to move changenotes to CHANGELOG.md Sep 18, 2026

mario-campos requested a review from mbg September 21, 2026 16:42

mbg previously approved these changes Sep 21, 2026

View reviewed changes

Update JSDoc comment with parameter lines

7715606

Co-authored-by: Michael B. Gale <mbg@github.com>

mario-campos dismissed mbg’s stale review via 7715606 September 21, 2026 21:28

mario-campos and others added 4 commits September 21, 2026 16:28

Apply suggestion from @mbg

598cda3

Co-authored-by: Michael B. Gale <mbg@github.com>

Rename name to absolutePath for clarity

c496c6c

Format code with npm run lint-fix

0263122

Replace JSDoc text with @throws

c0bd54f

Flesh out a comment

b1668d6

mbg approved these changes Sep 22, 2026

View reviewed changes

mario-campos added this pull request to the merge queue Sep 22, 2026

github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Sep 22, 2026

mario-campos added this pull request to the merge queue Sep 22, 2026

Merged via the queue into main with commit 6dd161b Sep 22, 2026
233 checks passed

mario-campos deleted the mario-campos/merge-changenotes branch September 22, 2026 13:09

This was referenced Sep 23, 2026

Merge main into releases/v4 #4164

Closed

Merge main into releases/v4 #4168

Merged

Merge releases/v4 into releases/v3 #4171

Merged

Add `changenotes.mts assemble` command to move changenotes to CHANGELOG.md by mario-campos · Pull Request #4155 · github/codeql-action · GitHub

Repository navigation

Add changenotes.mts assemble command to move changenotes to CHANGELOG.md - #4155

Add changenotes.mts assemble command to move changenotes to CHANGELOG.md#4155mario-campos merged 18 commits intomaingithub/codeql-action:mainfrom mario-campos/merge-changenotesgithub/codeql-action:mario-campos/merge-changenotesCopy head branch name to clipboard

Conversation

mario-campos commented Sep 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Risk assessment

Which use cases does this change impact?

How did/will you validate this change?

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

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mbg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mbg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mbg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Add changenotes.mts assemble command to move changenotes to CHANGELOG.md#4155
mario-campos merged 18 commits into
mainfrom
mario-campos/merge-changenotes

mario-campos commented Sep 18, 2026 •
edited
Loading