This document is a checklist for the release process of the dns-bench
project.
- Ensure that the CHANGELOG.md contains all unreleased changes and adheres to the Keep a Changelog format.
- Ensure that the README.md and /docker/OVERVIEW.md contain all the necessary information about the new version.
- Ensure that GitHub Actions CI is passing and MSRV is not changed, if changed update badge in README.md, CHANGELOG.md and Cargo.toml.
- Define a new version according to Semantic Versioning and update it inside the following files:
- Tag version in README.md and /docker/OVERVIEW.md installation instructions.
-
version
property in Cargo.toml to the new version. - Tag version in Dockerfile, docker-build.sh and docker-push.sh.
- Rename
Unreleased
section in CHANGELOG.md to the new version and date.
- Rebuild Cargo.lock by running
cargo build
. - Commit changes with message
v<version>
. - Run
cargo publish
to publish the crate to crates.io. - Run
/docker/build.sh
to build a new Docker image. - Run
/docker/push.sh
to push the new Docker image to Docker Hub. - Update repository overview in Docker Hub.