-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Release checklist
skshetry edited this page Mar 6, 2024
·
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/suffix to the version number(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:
- Using GitHub WebUI
-
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. Use
--title <title>
if you are creating from a CLI. -
Monitor GitHub Actions and PyPI to confirm that they are built and uploaded correctly. Some packages may have their respective conda packages too, so please watch out for those too (they are automatically created by a bot, but might need manual merges).
- 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/status#package-builders are deployed, go to iterative/lambda-latest-version, and merge automatically genenerated PR. Also look for an update PR in iterative/dvc.org which is used for download links, and merge them.
- GHA will deploy deb/rpm to aws automatically.
#! /bin/sh
if [ $# -eq 0 ]; then
echo "Usage: ${0##*/} <version>"
exit 1
fi
gh release create $1 --generate-notes -R iterative/dvc
gh repo list iterative --topic dvc-pkg-builder --json name --jq ".[].name" | xargs -I{} gh workflow run update.yaml -R iterative/{}
./release-dvc.sh 3.1.0