-
Notifications
You must be signed in to change notification settings - Fork 434
Abridge release notes #3403
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Abridge release notes #3403
Conversation
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.
Pull request overview
This pull request abridges the release notes to improve their display on the releases page and in Dependabot version updates. The changes remove redundant information and add helpful links to bundle releases.
Changes:
- Modified
prepare_changelog.pyto exclude version headings and footer text from extracted changelog snippets, as these are redundant when creating GitHub releases - Updated
bundle_changelog.pyto include a link to the corresponding bundle release in changelog notes - Added shebangs to both Python scripts for direct executability
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
.github/workflows/script/prepare_changelog.py |
Simplified changelog extraction logic to exclude version headings and footer text, making release notes more concise |
.github/workflows/script/bundle_changelog.py |
Added bundle release URL linking to provide users with direct access to CLI and language pack changes |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Abridge release notes so they display better on the releases page and in Dependabot version updates.
Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
Affects the release process only.
How did/will you validate this change?
Tested locally.
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?
Check the release notes during the next bundle and Action release.
Are there any special considerations for merging or releasing this change?
Merge / deployment checklist