Repository navigation
Migrate bundle update workflow to new changenote tooling - #4285
Open
henrymercer wants to merge 2 commits into
Open
henrymercer wants to merge 2 commits into
henrymercer wants to merge 2 commits into
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues block the migration of bundle-update release notes to the changenote pipeline.
No open issues 🎉
What changed in this PR
Moves bundle-update release notes into the existing changenote pipeline, so bundle update PRs no longer modify CHANGELOG.md directly or need an exception to the check proposed in #4217.
Changes:
- Creates version-specific changenote files with links to the bundle release and update PR.
- Replaces changelog-editing tests with checks for changenote content and validity.
- Explicitly stages new changenote files before committing and pushing.
| File | Description |
|---|---|
pr-checks/bundle-changelog.ts |
Writes a bundle-update changenote instead of editing the changelog. |
pr-checks/bundle-changelog.test.ts |
Tests generated note contents and compatibility with changenote validation. |
.github/workflows/update-bundle.yml |
Stages and commits the new changenote files. |
Review effort: Balanced (auto)
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The "Update default CodeQL bundle" workflow currently adds its "Update default CodeQL bundle version" entry directly to the
[UNRELEASED]section ofCHANGELOG.md. This PR changespr-checks/bundle-changelog.tsto write the entry to a changenote file inunreleased-change-notes/instead, so that it's added to the changelog with the other changenotes when we release.The workflow now stages the
unreleased-change-notesdirectory, sincegit commit -adoesn't pick up new files.With this change, bundle update PRs no longer modify
CHANGELOG.md, so they won't need to be excluded from the check added in #4217.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/bundle-changelog.tslocally and checked thatnpx tsx pr-checks/changenotes.ts validateaccepts the generated note and thatnpx tsx pr-checks/changenotes.ts assembleadds it to the[UNRELEASED]section ofCHANGELOG.md. The workflow only runs when a CodeQL bundle prerelease is published, so the next bundle update will be its first run.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