diff --git a/CHANGELOG.md b/CHANGELOG.md index 251b25f..b1b9e8f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed - Fixed api calls to language tool server to adhere to spec. Pass POST calls as `application/x-www-form-urlencoded`. [#129](https://github.com/jeertmans/languagetool-rust/pull/129) +- Fixed `RELEASE-PROCESS.md` description [#133](https://github.com/jeertmans/languagetool-rust/pull/133) ## [2.1.4](https://github.com/jeertmans/languagetool-rust/compare/v2.1.3...v2.1.4) diff --git a/Cargo.toml b/Cargo.toml index 88b607c..87a322b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -65,6 +65,8 @@ pre-release-replacements = [ {file="CHANGELOG.md", search="\\.\\.\\.HEAD\\)", replace="...{{version}}) {{date}}", exactly=1}, {file="CHANGELOG.md", search="", replace="\n\n## [Unreleased](https://github.com/jeertmans/languagetool-rust/compare/v{{version}}...HEAD)", exactly=1}, ] +tag = false +publish = false [package.metadata.docs.rs] all-features = true diff --git a/RELEASE-PROCESS.md b/RELEASE-PROCESS.md index eaadbaa..87f21fc 100644 --- a/RELEASE-PROCESS.md +++ b/RELEASE-PROCESS.md @@ -1,10 +1,10 @@ # Release process -First, make sure you are logged-in https://crates.io with: `cargo login`. If you don't have write access to **LanguageTool-Rust**' crates, you can still -perform steps 1-4, and ask a maintainer with accesses to perform step 5. +perform steps 1-3, and ask a maintainer with accesses to perform step 4 + +This project uses `cargo-release` to bump the version number and update the change log with more ease. -This project uses `cargo-release` to publish all packages with more ease. Note that, by default, every command runs in *dry mode*, and you need to append `--execute` to actually perform the action. @@ -14,13 +14,9 @@ cargo install cargo-release ``` Here are the following steps to release a new version: -1. create a branch `release-x.y.z` from the `main` branch; -2. run and commit `cargo release version `; -3. run and commit `cargo release replace`; -4. push your branch and create a pull request; -5. and, once your branch was merged to `main`, run the following: - ```bash - cargo release publish --package languagetool-rust - ``` +1. create a branch `release-x.y.z` from the main branch; +2. run `cargo release `; +3. create a pull request; +4. and, once your branch was merged to `main` tag it `vx.y.z` and push it (we prefer to create tags through GitHub releases) And voilĂ !