utilities/kmon
utilities/kmon
1
0
Fork 0
mirror of https://github.com/orhun/kmon synced 2024-07-03 08:08:59 +00:00
Code Issues Projects Releases Wiki Activity

doc: Update the release instructions

Browse Source
This commit is contained in:
orhun 2021-07-16 23:13:11 +03:00
parent e87b15f4c0
commit 533d87e1ad
No known key found for this signature in database
GPG Key ID: F83424824B3E4B90
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
RELEASE.md
View File

@ -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