astronomer Release v$ARGUMENTS
You are releasing version $ARGUMENTS of the airflow-blueprint package. Follow every step in order. Do not skip steps. Stop and ask the user if anything fails.
1. Validate the version argument
- $ARGUMENTS must be a valid semver string (e.g.
0.3.0,1.0.0). Reject pre-release suffixes unless the user explicitly asked for one. - Read
blueprint/__init__.pyand confirm the current__version__is older than $ARGUMENTS. - Determine whether this is a patch release (patch component > 0, e.g.
0.2.1) or a minor/major release (patch component is 0, e.g.0.3.0,1.0.0).
2. Run local quality checks
Run all three in parallel:
uv run ruff check blueprint/ tests/uv run ruff format --check blueprint/ tests/uv run pytest tests/ -v(unit and integration tests)
All must pass before continuing.
Patch release flow (e.g. 0.2.1, 1.3.2)
Patch releases are made from a release branch off the previous tag, not from main. This allows bug fixes to be released without pulling in unreleased feature work on main.
3p. Create a release branch from the previous tag
Find the previous tag in the same minor series (e.g. for 0.2.1 use v0.2.0, for 0.2.2 use v0.2.1).
git checkout -b release/v$ARGUMENTS <previous_tag>
4p. Cherry-pick bug fixes
Ask the user which commits to include. Show them the commits on main since the previous tag to help them choose:
git log <previous_tag>..main --oneline
Cherry-pick each selected commit onto the release branch:
git cherry-pick <commit_sha>
If any cherry-pick has conflicts, stop and ask the user for guidance.
5p. Bump the version, tag, and push
- Edit
blueprint/__init__.py: set__version__ = "$ARGUMENTS" git add blueprint/__init__.pygit commit -m "Release v$ARGUMENTS"git push -u origin release/v$ARGUMENTSgit tag v$ARGUMENTSgit push origin v$ARGUMENTS
This triggers the release workflow which builds and publishes to PyPI and TestPyPI.
6p. Continue to step 8.
Minor/major release flow (e.g. 0.3.0, 1.0.0)
Minor and major releases are made from main via a PR.
3. Create a release branch and bump the version
git checkout -b release/v$ARGUMENTS- Edit
blueprint/__init__.py: set__version__ = "$ARGUMENTS" git add blueprint/__init__.pygit commit -m "Release v$ARGUMENTS"git push -u origin release/v$ARGUMENTS
4. Open a PR
gh pr create --title "Release v$ARGUMENTS" --body "Bump version to $ARGUMENTS."
5. Wait for CI to pass
gh pr checks <PR_NUMBER> --watch- All checks must pass. If any fail, investigate and fix before continuing.
6. Merge the PR
gh pr merge <PR_NUMBER> --squash
7. Tag the merge commit on main
git checkout main && git pullgit tag v$ARGUMENTSgit push origin v$ARGUMENTS
This triggers the release workflow which builds and publishes to PyPI and TestPyPI.
Common steps (both flows)
8. Wait for the release workflow to pass
- Find the workflow run:
gh run list --branch v$ARGUMENTS --limit 1 - Watch it:
gh run watch <RUN_ID> - Confirm that the Publish to PyPI and Publish to TestPyPI jobs both succeed.
9. Draft release notes
Before creating the release, analyze all commits since the last tag to draft release notes. Use git log <previous_tag>..v$ARGUMENTS --oneline and read the relevant diffs to understand each change.
Structure the notes as:
## What's new
### Feature title (PR #)
Short description of the feature and how to use it.
(repeat for each feature)
---
## Breaking changes
### Change title
Description of what changed, what the old behavior was, and how to migrate.
(only include this section if there are breaking changes)
---
**Full Changelog**: https://github.com/astronomer/blueprint/compare/<previous_tag>...v$ARGUMENTS
Guidelines:
- Group related PRs together under a single heading when they are part of the same feature.
- Omit purely internal changes (CI, test infra, docs-only) from the top-level notes unless they are significant to users.
- For breaking changes, always include a before/after code example showing the migration path.
10. Create the GitHub release
gh release create v$ARGUMENTS --title "v$ARGUMENTS" --notes "<drafted notes>"
11. Clean up
- Delete the local release branch:
git branch -d release/v$ARGUMENTS - Report the release URL and a summary to the user.