From e702eea1e3a1de43d4329e2d6fa7c7f328fa9644 Mon Sep 17 00:00:00 2001 From: Kasper Date: Thu, 20 Aug 2020 10:49:52 +0200 Subject: [PATCH] Added instructions for releasing new version to readme --- Cargo.toml | 2 +- README.md | 20 +++++++++++++++++++- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 3f427be..58427a2 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -8,7 +8,7 @@ readme = "README.md" license = "MIT" homepage = "https://github.com/probablykasper/cpc#readme" repository = "https://github.com/probablykasper/cpc" -keywords = ["cpc", "math", "expression", "string", "evaluator", "eval", "units", "convert", "conversion"] +keywords = ["math", "expression", "evaluate", "units", "convert"] categories = ["mathematics", "science", "parsing", "text-processing", "value-formatting"] [dependencies] diff --git a/README.md b/README.md index 25c78c1..88debc3 100644 --- a/README.md +++ b/README.md @@ -187,4 +187,22 @@ Nice list of units: https://support.google.com/websearch/answer/3284611 - Linux target: `x86_64-unknown-linux-musl` - Windows target: `x86_64-pc-windows-gnu` - In case you want to compile for more targets, check out [the targets `cross` supports](https://github.com/rust-embedded/cross#supported-targets) -4. The compiled binaries will now be available inside `target//release/`. The filename will be either `cpc` or `cpc.exe`. +The compiled binaries will now be available inside `target//release/`. The filename will be either `cpc` or `cpc.exe`. + +### Releasing a new version + +1. Update `CHANGELOG.md` +2. Bump the version number in `Cargo.toml` and run `cargo check` +3. Cross-compile cpc by following [the steps above](#cross-compiling) +4. Commit and tag in format `v1.0.0` +5. Publish on crates.io: + 1. Login by running `cargo login` and following the instructions + 2. Test publish to ensure there are no issues + ``` + cargo publish --dry-run + ``` + 3. Publish + ``` + cargo publish + ``` +6. Create GitHub release with release notes and attach binaries