chore(version): release v0.14.2 (#422)

* chore(version): release v0.14.2 chore(docs): add release steps * fix(docs): admonition * fix(docs): typo
maciejhirsz · Sep 18, 2024 · 196c8c0 · 196c8c0
1 parent 028bd89
commit 196c8c0
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 5 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -13,7 +13,7 @@ license = "MIT OR Apache-2.0"
 readme = "README.md"
 repository = "https://github.com/maciejhirsz/logos"
 rust-version = "1.70.0"
-version = "0.14.1"
+version = "0.14.2"
 
 [package]
 name = "logos"
@@ -64,7 +64,7 @@ bench = {lto = true}
 release = {lto = true}
 
 [dependencies]
-logos-derive = {version = "0.14.1", path = "./logos-derive", optional = true}
+logos-derive = {version = "0.14.2", path = "./logos-derive", optional = true}
 
 [dev-dependencies]
 ariadne = {version = "0.2.0", features = ["auto-color"]}

diff --git a/README.md b/README.md
@@ -95,6 +95,46 @@ test strings                           ... bench:         553 ns/iter (+/- 34) =
 If you'd like to contribute to Logos, then consider reading the
 [Contributing guide](https://maciejhirsz.github.io/logos/contributing).
 
+## Contributing
+
+**Logos** welcome any kind of contribution: bug reports, suggestions,
+or new features!
+
+Please use the
+[issues](https://github.com/maciejhirsz/logos/issues) or
+[pull requests](https://github.com/maciejhirsz/logos/pulls) tabs,
+when appropriate.
+
+### Releasing a new version
+
+> [!NOTE]
+>
+> This section is only useful to **Logos**' maintainers.
+
+First, make sure you are logged-in https://crates.io with: `cargo login`.
+If you don't have write access to **Logos**' 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 `master` 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 `master`, run the following:
+   ```bash
+   cargo release publish --package logos-codegen
+   cargo release publish --package logos-derive
+   cargo release publish --package logos-cli
+   cargo release publish --package logos
+   ```
+
+And voilà!
+
 ## License
 
 This code is distributed under the terms of both the MIT license

diff --git a/book/src/getting-started.md b/book/src/getting-started.md
@@ -4,7 +4,7 @@
 
 ```toml
 [dependencies]
-logos = "0.14.1"
+logos = "0.14.2"
 ```
 
 Then, you can automatically derive the [`Logos`](https://docs.rs/logos/latest/logos/trait.Logos.html) trait on your `enum` using the `Logos` derive macro:

diff --git a/logos-cli/Cargo.toml b/logos-cli/Cargo.toml
@@ -2,7 +2,7 @@
 anyhow = "1.0.57"
 clap = {version = "3.1.18", features = ["derive"]}
 fs-err = "2.7.0"
-logos-codegen = {version = "0.14.1", path = "../logos-codegen"}
+logos-codegen = {version = "0.14.2", path = "../logos-codegen"}
 proc-macro2 = "1.0.39"
 
 [dev-dependencies]

diff --git a/logos-derive/Cargo.toml b/logos-derive/Cargo.toml
@@ -1,5 +1,5 @@
 [dependencies]
-logos-codegen = {version = "0.14.1", path = "../logos-codegen"}
+logos-codegen = {version = "0.14.2", path = "../logos-codegen"}
 
 [features]
 # Enables debug messages