~azzamsa/bilal.rs

4fa3c02d4802b505548c73f0dae7370ac0496e92 — azzamsa 7 months ago 559ca4a
docs: add release steps
2 files changed, 13 insertions(+), 7 deletions(-)

M docs/dev/release.sh
A docs/dev/releasing.md
M docs/dev/release.sh => docs/dev/release.sh +0 -7
@@ 1,8 1,5 @@
VERSION=`awk '/version = "[0-9]\.[0-9]\.[0-9]"/' Cargo.toml | awk -F\" '{print $2}'`

# init
cargo fmt

# GNU/Linux
cargo build --release
strip target/release/bilal


@@ 11,7 8,3 @@ mv target/release/bilal target/release/bilal-$VERSION
# Windows PC
cargo build --release --target=x86_64-pc-windows-gnu
mv target/x86_64-pc-windows-gnu/release/bilal.exe target/x86_64-pc-windows-gnu/release/bilal-$VERSION.exe

# don't forget!
echo "Check the changelog!" >> CHANGELOG.md
echo "Check the version!" >> Cargo.toml

A docs/dev/releasing.md => docs/dev/releasing.md +13 -0
@@ 0,0 1,13 @@
# Release Checklist

- Run linting:

``` bash
$ find . | grep "\.rs" | xargs touch ; cargo clippy --all-features -- --deny warnings --deny clippy::pedantic --deny clippy::nursery
```

- Run `cargo update` and review dependency updates.
- Update the CHANGELOG.
- Update version numbers in `Cargo.toml` and `README.md`, Run `cargo update -p bilal` so that the Cargo.lock is updated.
- Create new branch (master branch is protected), commit with a message format: `v[0-9]+.[0-9]+.[0-9]+`, and push.
- Wait for a checks to pass, merge the branch to master, then tag a release with a copy of the relevant section of the CHANGELOG.