Skip to content

chore(release): add patch release helper script - #31626

Open
ShaneK wants to merge 1 commit into
mainfrom
chore/deploy-script
Open

ShaneK wants to merge 1 commit into
mainfrom
chore/deploy-script

Conversation

@ShaneK

@ShaneK ShaneK commented Oct 21, 2026

Copy link
Copy Markdown
Member

Issue number: internal


What is the current behavior?

Currently, patch releases are done by hand from the Confluence checklist. That means creating the release branch, running the release workflow, opening two PRs, turning on merge commits, merging with the exact commit format, turning merge commits back off and then setting up the Jira release. It's easy to miss a step, and forgetting to turn merge commits back off has happened before.

What is the new behavior?

This adds scripts/release-patch.sh, which walks through the patch release one step at a time. It runs the mechanical steps through gh and stops for anything that needs a person, like confirming the changelog or posting the code freeze in Slack. It turns merge commits on for the merges and back off afterwards, even if the script errors out or gets interrupted. It also prints a single Jira search link that finds the tickets for every PR in the release.

The Jira site and project key are read from ~/.config/ionic-release.env instead of being kept in the repo (to prevent them from being committed by accident), and scripts/release.env.example is the template for that file. The script stops before doing anything if that file is missing, if a value is still a placeholder, or if the account running it isn't a repo admin.

Does this introduce a breaking change?

  • Yes
  • No

Other information

⚠️ You must have the gh CLI installed and authenticated to run this script.

The values for the config file are on the Releases page on Confluence. Running ./scripts/release-patch.sh --dry-run goes through the whole release without changing anything, so it's the easiest way to try it out. Use --step N to resume a release that stopped partway through.

@ShaneK
ShaneK requested a review from a team as a code owner October 21, 2026 21:52
@ShaneK
ShaneK requested a review from brandyscarney October 21, 2026 21:52
@vercel

vercel Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
ionic-framework Ready Ready Preview Oct 21, 2026 9:53pm UTC

Request Review

This branch was successfully deployed

1 active deployment
Preview — 12ca3ca6 Deployed Oct 21, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant