Upcoming Release Summary
Generate a concise summary of PRs included in the upcoming release.
Prerequisites
Two commit SHAs are required:
-
First SHA: The older commit (current release)
-
Second SHA: The newer commit (what's being released)
If the user does not provide both SHAs, ask for them before proceeding.
Workflow
Run the script from the repository root with the --json flag:
.github/scripts/find_prs_between_commits.py <older-sha> <newer-sha> --json
Filter out PRs that are:
-
Chores
-
Dependency updates
-
Adding logs
-
Refactors
Categorize the remaining PRs:
-
Features - New functionality
-
Bug fixes - Corrections to existing behavior
-
Security/CVE fixes - Security-related changes
-
Other - Everything else
Format the output with PRs listed under their category, including the PR number and a brief description.