kanidm/project_docs/RELEASE_CHECKLIST.md
2022-08-02 13:14:25 +10:00

66 lines
1.4 KiB
Markdown

## Pre-Reqs
cargo install cargo-audit
cargo install cargo-outdated
cargo install cargo-release
## Check List
### Start a release
* [ ] git checkout -b YYYYMMDD-release
### Code Changes
* [ ] upgrade crypto policy values if requires
* [ ] bump index version in constants
* [ ] check for breaking db entry changes.
* [ ] cargo test
### Cargo Tasks
* [ ] cargo outdated -R
* [ ] cargo audit
* [ ] cargo test
* [ ] build wasm components with release
### Administration
* [ ] cargo release --no-dev-version --no-push --no-publish --no-tag 1.1.0-alpha.X
* [ ] git rebase -i HEAD~X
* [ ] Update `RELEASE_NOTES.md`
* [ ] git commit
* [ ] git push origin YYYYMMDD-release
* [ ] Merge PR
### Git Management
* [ ] git checkout master
* [ ] git branch 1.1.0-alpha.x (Note no v to prevent ref conflict)
* [ ] git checkout v1.1.0-alpha.x
* [ ] git tag v1.1.0-alpha.x
* [ ] Final inspect of the branch
* [ ] git push origin 1.1.0-alpha.x
* [ ] git push origin 1.1.0-alpha.x --tags
### Cargo publish
* [ ] publish `kanidm_proto`
* [ ] publish `kanidmd/kanidm`
* [ ] publish `kanidm_client`
* [ ] publish `kanidm_tools`
### Docker
* [ ] docker buildx use cluster
* [ ] `make buildx/kanidmd/x86_64_v3 buildx/kanidmd buildx/radiusd`
* [ ] Update the readme on docker https://hub.docker.com/repository/docker/kanidm/server
### Distro
* [ ] vendor and release to build.opensuse.org