Release Checklist
Pre-Reqs
cargo install --force \
cargo-audit \
cargo-outdated \
cargo-udeps \
cargo-machete
Pre Release Check List
Start a release
-
git checkout -b "$(date +%Y%m%d)-pre-release"
Cargo Tasks
-
Update MSRV if applicable
-
cargo update -
cargo +nightly udeps -
cargo machete --with-metadata -
cargo outdated -R -
cargo audit -
cargo test -
setup a local instance and run orca (TBD)
-
store a copy an an example db (TBD)
Code Changes
- upgrade crypto policy values if required (see
libs/crypto/src/lib.rs->CryptoPolicy) - check for breaking db entry changes.
Administration
- Update
RELEASE_NOTES.md - Update
README.md -
cargo test -
git commit -a -m 'chore: Release Notes' -
git push origin "$(date +%Y%m%d)-pre-release" - Merge PR
Git Management
-
git checkout master -
git pull -
git checkout -b 1.x.0 (Note no v to prevent ref conflict)
-
update version to set pre tag in ./Cargo.toml
-
update Makefile to set docker image to rc
-
Final inspect of the branch
-
git commit -a -m -S ‘Release 1.x.0-pre’
-
git tag v1.x.0
-
git push upstream 1.x.0 –tags
-
github -> Ensure release branch is protected
Follow up
- git checkout master
- git pull
-
git checkout -b "$(date +%Y%m%d)-dev-version" - update version to +1 and add dev tag in ./Cargo.toml
- update
DOMAIN_*_LEVELin server/lib/src/constants/mod.rs - update and add new migrations
- git commit -a -m -S ‘Release 1.x.0-dev’
- Merge PR
- git checkout master
- git pull
- git tag v1.x.0-dev
- git push upstream master –tags
Final Release Check List
Git Management Part Deux
-
git checkout 1.x.0
-
git pull upstream 1.x.0
-
update version to remove pre tag in ./Cargo.toml
-
update Makefile to set docker image to latest
-
git commit -a -m -S ‘Release 1.x.0’
-
git tag v1.x.0
-
git push upstream 1.x.0 –tags
-
github -> create new release based on tag (not branch) - use tag because then tools will get the tag + patches we apply.
Community
- Publish release announcement
Cargo publish
- make publish
Docker
-
docker buildx use cluster
-
make buildx -
Update the readme on docker https://hub.docker.com/repository/docker/kanidm/server
-
Sign artefacts
-
make cosign
Distro
- vendor and release to build.opensuse.org