Release 0.3.11
Evergreen Releases - Prep Steps:
An Evergreen
release process means we are always releasing. We open a new release ticket as soon as we've completed the prior release. (It's therefore the final step in this checklist.)
"Evergreen Prep" Checklist
-
Open this Issue -
Indicate the version to be released here in the issue's title Release vX.Y.Z
- If the release number changes (from minor to major or patch, for instance), update the version here and in the issue description.
Readiness Checklist:
Engineering
team, to get ready for the upcoming release:
-
Ensure any already-merged commits since the last release have Changelog entries (excepting non-user-impacting commits, such as docs fixes). -
Create a comment in the #engineering-team
slack channel with pending-but-not-merged MRs, potentially shipping. (Aka, the "burndown" list.)- Otherwise a comment that all known merge candidates are already merged.
-
Create or link to a summary of MRs merged and/or expected in the #marketing
Slack channel, with an@channel
mention.
Release Checklist
Rotating assignee
, on the morning of the release:
-
Changelog updates and version bump: -
Create a new branch named release/vX.Y.Z
and a corresponding MR with theRelease
MR template. - An automated pipeline (linked to the branch prefix
release/v*
) will immediately and automatically bump the version and flush the changelog.-
Check this box to confirm the automated changelog flush and version bump are correct. - You do not need to wait for the CI pipeline. (An identical CI pipeline is already included in the below.)
from
main
branch.
-
-
-
Cut a release tag from your release/vX.Y.Z
branch namedvX.Y.Z
with Message=Release vX.Y.Z
- In response to new tag creation, these steps are performed automatically in Gitlab pipelines:
- Abort if tag
vX.Y.Z
does not match output frompoetry version --short
- Test everything.
- Publish to PyPi .
- Abort if tag
- Validate publish once the pipeline finishes. (While the process is running, you can continue with next steps, such as changelog grooming.)
-
Check this box when the tag's pipeline has completed (eta 40-60 minutes). -
Check this box when PyPi publish is confirmed.
-
- In response to new tag creation, these steps are performed automatically in Gitlab pipelines:
- Groom the changelog:
-
Compare the Changelog against the main
branch commit history and add any significant user-impacting updates (excluding docs and website updates, for instance). -
Review the Changelog for readability and typoes, committing fixes or updates if needed. -
Final changelog review: - Open the Changelog in preview mode, mouse over each link and ensure tooltip descriptions match the resolved issue.
- Check contributor profile links to make sure they are correct.
-
Merge the resulting MR to main
with the merge commit messageRelease vX.Y.Z
-
Check the pending MRs to make sure nothing is missing -
Open the next Release
issue using theRelease
template.
-
Announcements, Marketing, and Promotion
Marketing
or Product
team:
-
Post-release announcement steps: -
Post announcement to Meltano slack: #announcements
-
Cross-post (share) to #sdk
- Copy-paste to:
-
Singer
slack:#meltano
,#singer-sdk
-
dbt
slack:#tools-meltano
-
-
Blog post -
Tweet the blog post
-
Edited by Florian