summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authororhun <orhun@archlinux.org>2021-07-16 23:13:11 +0300
committerorhun <orhun@archlinux.org>2021-07-16 23:13:11 +0300
commit533d87e1ad258ce158238f81d448a4416d88d308 (patch)
tree1bcba94b41491ad09f6e9d8480dbfebe90243d00
parente87b15f4c0c0726c4d170a0d6757d5cabb961ba5 (diff)
doc: Update the release instructions
-rw-r--r--RELEASE.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/RELEASE.md b/RELEASE.md
index a096fcb..9412ad0 100644
--- a/RELEASE.md
+++ b/RELEASE.md
@@ -2,12 +2,13 @@
[GitHub](https://github.com/orhun/kmon/releases), [crates.io](https://crates.io/crates/kmon/) and [Docker](https://hub.docker.com/r/orhunp/kmon) releases are automated via [GitHub actions](https://github.com/orhun/kmon/blob/master/.github/workflows/cd.yml) and triggered by pushing a tag.
-1. Bump the [version](https://semver.org/spec/v2.0.0.html) in [Cargo.toml](https://github.com/orhun/kmon/blob/master/Cargo.toml) and run the app to update [Cargo.lock](https://github.com/orhun/kmon/blob/master/Cargo.lock).
-2. Ensure [CHANGELOG.md](https://github.com/orhun/kmon/blob/master/CHANGELOG.md) is updated according to the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.
-3. Commit and push the changes.
-4. Create a new tag: `git tag -s -a v[x.y.z]`
-5. Push the tag: `git push --tags`
-6. Wait for [Continous Deployment](https://github.com/orhun/kmon/actions) workflow to finish.
+1. Bump the version in [Cargo.toml](Cargo.toml) according to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+2. Update [Cargo.lock](Cargo.lock) by building the project: `cargo build`
+3. Ensure [CHANGELOG.md](CHANGELOG.md) is updated according to [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.
+4. Commit and push the changes.
+5. Create a new tag: `git tag -s -a v[x.y.z]` ([signed](https://keyserver.ubuntu.com/pks/lookup?search=0x485B7C52E9EC0DC6&op=vindex))
+6. Push the tag: `git push --tags`
+7. Wait for [Continous Deployment](https://github.com/orhun/kmon/actions) workflow to finish.
## License