features, cleanup and bug fixes #26

Merged
ben merged 30 commits from ben/Jobboerse:main into main 2022-06-09 17:36:55 +02:00
Showing only changes of commit 964a001d5e - Show all commits

add "how to cut a release" readme section

Bennet Bleßmann 2022-06-09 17:23:54 +02:00 committed by Bennet Bleßmann
Signed by: ben
GPG key ID: 3BE1A1A3CBC3CF99

View file

@ -114,3 +114,18 @@ Check Formatting: `cargo fmt --check`
cargo-deny (installed separately): `cargo deny check` cargo-deny (installed separately): `cargo deny check`
cargo-msrc (installed separately): `cargo msrv --verify` cargo-msrc (installed separately): `cargo msrv --verify`
Cutting a Release
-----------------
* Update the version in the root Cargo.toml according to semver, this will be the version to-be-cut
* Update the changelog the reflection all changes since the last release unter `[Unreleased]`
* It's generally recommended to keep the Changelog upto date by adding changes to the unreleased section in the commit that introduces the change
* In the now up-to-date changelof add a new section heading for the version to-be-cut between `[Unreleasd]` and the first entry of the unreleased section
* Add a matching link definition at the bottom of a changelog
* Update the version in dist/arch/PKGBUILD to match the version to-be-cut
* run cargo test to update the version in the Cargo.lock file and check that the tests pass
* Commit & Push your changes and wait for them to be merged
* Tag the merge(d) commit as the release and push the tag
* You have Cut a new Release, Congratulations