Skip to content

Commit

Permalink
add release process and changelog update
Browse files Browse the repository at this point in the history
  • Loading branch information
okaerin committed Feb 24, 2025
1 parent 22c6757 commit 1b45f6f
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Fixed some types. [#115](https://github.com/jeertmans/languagetool-rust/pull/115)
- Derive `Hash` on requests types. [#114](https://github.com/jeertmans/languagetool-rust/pull/114)
- Use Codspeed and `check-changelog` actions. [#121](https://github.com/jeertmans/languagetool-rust/pull/121)
- Use `cargo release` and add `RELEASE-PROCESS.md` [#130](https://github.com/jeertmans/languagetool-rust/pull/130)

### Fixed

Expand Down
22 changes: 22 additions & 0 deletions RELEASE-PROCESS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# 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.

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.

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 --workspace <LEVEL>`;
3. run and commit `cargo release replace --workspace`;
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
```

And voilà!

0 comments on commit 1b45f6f

Please sign in to comment.