support generating notes of merged PRs with rebase #18458
Merged
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ |
bmwill
approved these changes
Jun 28, 2024
quepcompute
approved these changes
Jun 28, 2024
tx-tomcat
pushed a commit
to tx-tomcat/sui-network
that referenced
this pull request
Jul 29, 2024
## Description When merging a PR, we can either use `squashed` or `rebase`. Before, our release note script supports `squashed` commit only, this change will add support to `rebase` PR as well. The downside of this is it might take a bit longer to run given that we'll need to send a HTTP request to Github API if it's not a squashed commit. But given this script won't be run more than once a week, it's a good tradeoff. ## Test plan `GITHUB_TOKEN=<my_PAT> python ./scripts/release_notes.py generate 9e2be6a 1428c71` (all the release notes from `releases/sui-v1.27.0-release` to `releases/sui-v1.28.0-release` branch) now shows @bmwill 's MystenLabs#18099 --- ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] Indexer: - [ ] JSON-RPC: - [ ] GraphQL: - [ ] CLI: - [ ] Rust SDK:
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.
Description
When merging a PR, we can either use
squashedorrebase.Before, our release note script supports
squashedcommit only, this change will add support torebasePR as well.The downside of this is it might take a bit longer to run given that we'll need to send a HTTP request to Github API if it's not a squashed commit. But given this script won't be run more than once a week, it's a good tradeoff.
Test plan
GITHUB_TOKEN=<my_PAT> python ./scripts/release_notes.py generate 9e2be6ad4185563ecd98bf35abfe92b86a0b280f 1428c71346045112c7adb1a316365c5cba325d9b(all the release notes from
releases/sui-v1.27.0-releasetoreleases/sui-v1.28.0-releasebranch) now shows @bmwill 's #18099Release notes
Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.
For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.