-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Release checklist
skshetry edited this page Nov 8, 2022
·
41 revisions
-
Check for blockers:
- Make sure tests are passing.
- Check if there are any issues with
release-blocker
labels.
-
Determine the next version number/tag:
- Determine if the next release is going to be a major, minor, or a patch version.
- Do not add any prefix or suffix to the version number/tag (eg:
v0.0.1
❌,0.0.1
✅). - Make sure to always have 3 components: major/minor/patch in the version number/tag (eg:
2.33
❌,2.33.0
✅).
-
Make a release:
-
Tip: First add a tag and then, click the
Auto-generate release notes
, which should fill other stuff automatically. -
Using
gh
CLI:gh release create 1.0.0 --generate-notes -R iterative/<repo>
If there's something interesting in the release, you can add that to the title so that users don't have to read all of the release notes.
-
- Monitor GitHub Actions and PyPI to confirm that they are built and uploaded correctly.
- Brew guys seem to now update our package automatically, but please keep an eye on it Homebrew/homebrew-core
- Our bot will once a day check dvc github releases and will create a PR for chocolatey-dvc, you will only need to merge it. Please keep an eye on the package page, since their test suite is flaky.
- Conda bots will automatically create a PR in dvc-feedstock when dvc is updated on pypi. Be sure to follow the instructions in the PR before merging it. For additional info see conda maintenance.
- After all packages in https://github.com/iterative/dvc-packages are deployed, go to iterative/lambda-latest-version, and merge automatically genenerated PR.
- GHA will deploy deb/rpm to aws automatically.
- request a new channel version-prefix (aka track) at https://forum.snapcraft.io/t/track-request-for-dvc/17735 (e.g.
v2
)- otherwise attempting to
snapcraft release --channel=v2
will fail
- otherwise attempting to
- create a new legacy-dev git branch (e.g.
1.x-dev
) - (optional) give a warning message: cherry-pick dvc@6f0a05ad. Wait ~30 days before continuing to the next step
- the idea is to warn & give 2 options: opt-in now, or opt-out permanently. Both options will suppress the warning. Ignoring the warning will result in an auto-upgrade in 30 days
- uncomment the
echo "unset SNAP_CHANNEL" >>env.sh
line inscripts/ci/before_install.sh