Skip to content

doc: fix release process doc #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
2 changes: 2 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ pre-release-replacements = [
{file="CHANGELOG.md", search="\\.\\.\\.HEAD\\)", replace="...{{version}}) {{date}}", exactly=1},
{file="CHANGELOG.md", search="<!-- next-header -->", replace="<!-- next-header -->\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
Expand Down
18 changes: 7 additions & 11 deletions RELEASE-PROCESS.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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 <LEVEL>`;
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 <version|LEVEL>`;
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à!
Loading