refactor: improve release notes script and add unit tests #2870
+410
−55
Conversation
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
- Add gh_api() helper function to consolidate GitHub API calls - Add list-prs command to list PRs with release notes as JSON - Add get-notes command to get formatted notes for a PR - Add pr_has_release_notes() function to check for checked notes - Refactor extract_notes_for_pr/commit to use gh_api helper - Wrap execution in if __name__ == "__main__" for module imports - Add release_notes_test.py with 20 unit tests - Rename workflow to release-notes.yml - Add release-notes-script-test job to run tests on script changes - Add isReleaseNotesScript detection to diffs action Co-Authored-By: Claude Opus 4.5 <[email protected]>
Co-Authored-By: Claude Opus 4.5 <[email protected]>
Co-Authored-By: Claude Opus 4.5 <[email protected]>
Co-Authored-By: Claude Opus 4.5 <[email protected]>
wbbradley
reviewed
Jan 17, 2026
Contributor
wbbradley
left a comment
wbbradley
left a comment
There was a problem hiding this comment.
Looks fine. I left some nits.
| json_data = gh_api(f"/repos/MystenLabs/walrus/pulls/{pr}") | ||
| if not json_data: | ||
| return False | ||
| body = json_data.get("body", "") |
Contributor
There was a problem hiding this comment.
Suggested change
| body = json_data.get("body", "") | |
| body = json_data.get("body") |
The default argument is not idiomatic in this setting. get will return None if there is no "body".
| # Execute the curl command | ||
| result = subprocess.run(curl_command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True) | ||
| json_data = json.loads(result.stdout) | ||
| message = json_data[0].get("body") if json_data else "" |
Contributor
There was a problem hiding this comment.
This ternary operator is not doing anything anymore.
Suggested change
| message = json_data[0].get("body") if json_data else "" | |
| message = json_data[0].get("body") |
| result = subprocess.run(curl_command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True) | ||
| json_data = json.loads(result.stdout) | ||
| pr = json_data[0].get("number") if json_data else "" | ||
| pr = json_data[0].get("number") if json_data else None |
Contributor
There was a problem hiding this comment.
Suggested change
| pr = json_data[0].get("number") if json_data else None | |
| pr = json_data[0].get("number") |
wbbradley
approved these changes
Jan 17, 2026
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.
Summary
gh_api()helper to consolidate GitHub API callslist-prsandget-notescommands for CI workflowsrelease-notes.ymland added automatic test execution when scripts changeBased on changes from MystenLabs/sui#24989
Test plan
python -m pytest release_notes_test.py -v)list-prsandget-notescommands work as expected🤖 Generated with Claude Code