features, cleanup and bug fixes #26
1 changed files with 15 additions and 0 deletions
add "how to cut a release" readme section
commit
964a001d5e
15
README.md
15
README.md
|
|
@ -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
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue