GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Incorporate change-notes into CHANGELOG.md at release by mario-campos · Pull Request #4201 · github/codeql-action

Conversation

@mario-campos

@mario-campos mario-campos commented Oct 6, 2026 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

This PR automates the effective execution of pr-checks/changenotes.mts assemble into the update-release-branch process by refactoring the code to be importable, and then importing it into pr-checks/update-release-branch.ts.

Testing

In my test fork, I dispatched update-release-branch.yml to confirm expected behaviour.

Test 1

  • update-release-branch.yml workflow run
  • Merge mario-campos/automate-changenotes-assemble into releases/v4 dsp-testing/mario-campos-post-comment-test#4

Test 2

  • update-release-branch.yml workflow run
  • Merge main into releases/v4 dsp-testing/mario-campos-post-comment-test#6
  • Merge releases/v4 into releases/v3 dsp-testing/mario-campos-post-comment-test#9
  • Mergeback v4.39.0 refs/heads/releases/v4 into main dsp-testing/mario-campos-post-comment-test#10

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).
  • End-to-end tests - I am depending on PR checks (i.e. tests in pr-checks).
  • Other - Manual testing

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@mario-campos
mario-campos requested a balanced review from Copilot October 6, 2026 18:45
@github-actions github-actions Bot added the size/S Should be easy to review label Oct 6, 2026
Copilot started reviewing on behalf of mario-campos October 6, 2026 18:46
View session
Copilot AI reviewed Oct 6, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

Changenote deletions are not committed and can occur before the changelog is successfully written.

Review effort: Balanced
Findings: 1 High severity

Open (1)
  • High severity Delete changenotes only after changelog write succeeds · New
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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread pr-checks/changenotes.ts Resolved

Uh oh!

There was an error while loading. Please reload this page.
@mario-campos
mario-campos requested a balanced review from Copilot October 6, 2026 18:52
Copilot started reviewing on behalf of mario-campos October 6, 2026 18:52
View session
Copilot AI reviewed Oct 6, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Copilot review overview

🟢 Approval recommended

The release workflow integration is focused and correctly stages both the populated changelog and removed changenotes.

Review effort: Balanced
Findings: None

Resolved since last review (1)
  • High severity Delete changenotes only after changelog write succeeds

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@mario-campos
mario-campos marked this pull request as ready for review October 6, 2026 19:11
@mario-campos
mario-campos requested a review from a team as a code owner October 6, 2026 19:11
@mario-campos
mario-campos requested a review from mbg October 6, 2026 19:11
@mario-campos
Hoist core of changenotes.mts assemble into own function
9a9f454
@mario-campos
mario-campos force-pushed the mario-campos/automate-changenotes-assemble branch from c91d2d4 to 67ca508 Compare October 6, 2026 19:39
mario-campos added 3 commits October 6, 2026 14:43
@mario-campos
Transfer change-notes to CHANGELOG.md via update-release-branch.ts
fb4048e
@mario-campos
Trim whitespace of change-notes before insertion
badda69
@mario-campos
Commit change-note deletions
0f6901c
@mario-campos
mario-campos force-pushed the mario-campos/automate-changenotes-assemble branch from 67ca508 to 0f6901c Compare October 6, 2026 19:43
mbg
mbg reviewed Oct 6, 2026
View reviewed changes

@mbg mbg left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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:

  1. 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.md directly. That can be an independent PR from this one.
  2. It would be good to improve our test coverage here for this. I know that changenotes.ts has 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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
mario-campos reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
Comment thread pr-checks/update-release-branch.ts Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread pr-checks/update-release-branch.ts Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread pr-checks/changenotes.ts Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread pr-checks/changenotes.ts Resolved

Uh oh!

There was an error while loading. Please reload this page.
@mario-campos
Use config vars over hardcoded literals
aae22cc
@mario-campos mario-campos mentioned this pull request Oct 7, 2026
Document change-notes process #4211
Merged
@mario-campos
mario-campos requested a review from mbg October 8, 2026 15:02
@mbg
Merge branch 'main' into mario-campos/automate-changenotes-assemble
a7700b5
@mbg

mbg commented Oct 14, 2026

Copy link
Copy Markdown
Member

Thanks for performing a test run! There are a couple of minor extra things to check there, which I have let you know. Once we have confirmed those, we can merge this.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
mbg
mbg approved these changes Oct 15, 2026
View reviewed changes
@mbg
mbg added this pull request to the merge queue Oct 15, 2026
Merged via the queue into main with commit 57938b8 Oct 15, 2026
237 checks passed

Uh oh!

There was an error while loading. Please reload this page.
@mbg
mbg deleted the mario-campos/automate-changenotes-assemble branch October 15, 2026 09:41
This was referenced Oct 15, 2026
Merge main into releases/v4 #4239
Merged
Merge releases/v4 into releases/v3 #4241
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@mbg mbg mbg approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

size/S Should be easy to review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@mario-campos @mbg
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.