Add pre-release prerequisite checks to perform-release.sh#11024
Draft
Add pre-release prerequisite checks to perform-release.sh#11024
Conversation
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
jbachorik
added
type: enhancement
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
PerfectSlayer
left a comment
PerfectSlayer
left a comment
There was a problem hiding this comment.
That's a lot of change for a script that was supposed to set and push a tag 😓
I would stick with the step that can make the tag and follow up actions failed, ie
- verify the user is part of the releaser (otherwise it creates a local tag)
- verify the milestone for the release exists (otherwise the changelog generation will fail).
Some other parts are wrong or duplicate of the existing GH workflows.
tooling/perform-release.sh
Outdated
Comment on lines
+114
to
+117
| if git rev-parse "refs/tags/$NEXT_RELEASE_VERSION" &>/dev/null; then | ||
| echo "❌ Tag '$NEXT_RELEASE_VERSION' already exists locally. Has this release already been tagged?" | ||
| exit 1 | ||
| fi |
Contributor
There was a problem hiding this comment.
❔ question: How is that even possible according how the next version tag is computed?
tooling/perform-release.sh
Outdated
Comment on lines
+118
to
+121
| if git ls-remote --tags "$REMOTE" "refs/tags/$NEXT_RELEASE_VERSION" | grep -q .; then | ||
| echo "❌ Tag '$NEXT_RELEASE_VERSION' already exists on remote '$REMOTE'. Has this release already been tagged?" | ||
| exit 1 | ||
| fi |
Contributor
There was a problem hiding this comment.
❔ question: Same question. Tags are fetch just above
tooling/perform-release.sh
Outdated
Comment on lines
+145
to
+162
| # Check that the milestone has no open issues or PRs | ||
| if ! OPEN_ISSUES=$(gh api "repos/{owner}/{repo}/milestones/$MILESTONE_NUMBER" \ | ||
| --jq ".open_issues"); then | ||
| echo "❌ Failed to query milestone '$MILESTONE_TITLE'. Check your network connection." | ||
| exit 1 | ||
| fi | ||
| if [ -z "$OPEN_ISSUES" ] || ! [[ "$OPEN_ISSUES" =~ ^[0-9]+$ ]]; then | ||
| echo "❌ Unexpected response when querying open issue count for milestone '$MILESTONE_TITLE': '$OPEN_ISSUES'." | ||
| exit 1 | ||
| fi | ||
| if [ "$OPEN_ISSUES" -gt 0 ]; then | ||
| echo "❌ Milestone '$MILESTONE_TITLE' still has $OPEN_ISSUES open issue(s) or PR(s):" | ||
| gh api "repos/{owner}/{repo}/issues?milestone=$MILESTONE_NUMBER&state=open&per_page=100" \ | ||
| --jq '.[] | " #\(.number) \(.title)"' || true | ||
| echo " All PRs must be merged before tagging a release." | ||
| exit 1 | ||
| fi | ||
| echo "✅ All issues and PRs in milestone '$MILESTONE_TITLE' are closed." |
Contributor
There was a problem hiding this comment.
🔨 issue: This is wrong. This is expected to have open issue on milestone.
Comment on lines
+164
to
+165
| # Check that all closed PRs in the milestone carry the required labels. | ||
| # Required: (comp:* or inst:*) AND (type:*), OR 'tag: no release notes'. |
Contributor
There was a problem hiding this comment.
❔ question: What's the point? It's a duplicate of the PR checks workflow.
tooling/perform-release.sh
Outdated
| echo " Only release owners are allowed to push release tags." | ||
| exit 1 | ||
| fi | ||
| echo "✅ GitHub CLI authenticated with push permission." |
Contributor
There was a problem hiding this comment.
🎯 suggestion: This should check the fact that you're part of the release owner teams.
Otherwise, the release must be done by a release owner.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
2 participants
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.
What Does This Do
Adds automated pre-release prerequisite checks to
tooling/perform-release.shthat validate the environment and repository state before creating a release tag:comp:/inst:+type:, ortag: no release note)Motivation
Previously the release script had minimal pre-flight checks, allowing a release to fail partway through (e.g. missing permissions, duplicate tag, unsigned tag). These checks catch problems early, before the irreversible tag-and-push step.
Additional Notes
The
confirmOrAbortfunction was refactored to accept a custom prompt parameter, enabling context-specific confirmation messages throughout the script.Contributor Checklist
type:and (comp:orinst:) labels in addition to any other useful labelsclose,fix, or any linking keywords when referencing an issueUse
solvesinstead, and assign the PR milestone to the issueJira ticket: [PROJ-IDENT]
Note: Once your PR is ready to merge, add it to the merge queue by commenting
/merge./merge -ccancels the queue request./merge -f --reason "reason"skips all merge queue checks; please use this judiciously, as some checks do not run at the PR-level. For more information, see this doc.