Add support for cargo release

Cargo.toml

@@ -10,7 +10,7 @@ members = [
 ]
 
 [workspace.package]
-version = "1.0.1"
+version = "1.1.0"
 authors = ["Sergio Benitez <sb@sergio.bz>"]
 license = "MIT OR Apache-2.0"
 edition = "2021"
@@ -20,9 +20,9 @@ repository = "https://github.com/rustfoo/rkt"
 readme = "README.md"
 
 [workspace.dependencies]
-rkt                     = { version = "1.0.1", path = "core/lib/", default-features = false }
-rkt_http                = { version = "1.0.1", path = "core/http/" }
-rkt_codegen             = { version = "1.0.1", path = "core/codegen/" }
+rkt                     = { version = "1.1.0", path = "core/lib/", default-features = false }
+rkt_http                = { version = "1.1.0", path = "core/http/" }
+rkt_codegen             = { version = "1.1.0", path = "core/codegen/" }
 
 [workspace.lints.rust]
 unexpected_cfgs = { level = "warn", check-cfg = ['cfg(nightly)'] }

README.md

@@ -36,7 +36,7 @@ Add `rkt` to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-rkt = "1.0.1"
+rkt = "1.1.0"
 ```
 
 ## Crates

contrib/dyn_templates/README.md

@@ -22,7 +22,7 @@ and automatically reloads templates when compiled in debug mode. It supports [Ha
 
      ```toml
      [dependencies.rkt_dyn_templates]
-     version = "1.0.1"
+     version = "1.1.0"
      features = ["handlebars", "tera", "minijinja"]
      ```
 

contrib/ws/README.md

@@ -16,7 +16,7 @@ This crate provides WebSocket support for rkt via integration with rkt's
 
      ```toml
      [dependencies]
-     ws = { package = "rkt_ws", version = "1.0.1" }
+     ws = { package = "rkt_ws", version = "1.1.0" }
      ```
 
    2. Use it!

core/codegen/src/lib.rs

@@ -19,7 +19,7 @@
 //!
 //! ```toml
 //! [dependencies]
-//! rkt = { version = "1.0.0" }
+//! rkt = { version = "1.1.0" }
 //! ```
 //!
 //! And to import all macros, attributes, and derives via `#[macro_use]` in the

core/lib/Cargo.toml

@@ -19,6 +19,33 @@ rust-version.workspace = true
 [package.metadata.docs.rs]
 all-features = true
 
+# cargo-release: keep documented version strings in lockstep with the workspace
+# version. These run once (scoped to the `rkt` crate); paths are relative to
+# this manifest (core/lib/), so `../../` reaches the repo root. See release.toml.
+[package.metadata.release]
+pre-release-replacements = [
+  { file = "../../README.md",                          search = 'rkt = "[0-9][0-9A-Za-z.-]*"',                       replace = 'rkt = "{{version}}"' },
+  { file = "../../website/src/pages/index.js",          search = 'rkt = "[0-9][0-9A-Za-z.-]*"',                       replace = 'rkt = "{{version}}"' },
+  { file = "../../website/docs/index.md",               search = 'guide for rkt v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z]+(\.[0-9A-Za-z]+)*)?', replace = 'guide for rkt v{{version}}' },
+  { file = "../../website/docs/02-getting-started.md",  search = 'rkt = "[0-9][0-9A-Za-z.-]*"',                       replace = 'rkt = "{{version}}"' },
+  { file = "../../website/docs/12-pastebin.md",         search = 'rkt = "[0-9][0-9A-Za-z.-]*"',                       replace = 'rkt = "{{version}}"' },
+  { file = "../../website/docs/14-faq.md",              search = 'rkt = \{ version = "[0-9][0-9A-Za-z.-]*"',          replace = 'rkt = { version = "{{version}}"' },
+  { file = "../../website/docs/10-configuration.md",    search = 'rkt = \{ version = "[0-9][0-9A-Za-z.-]*"',          replace = 'rkt = { version = "{{version}}"' },
+  { file = "../../website/docs/04-requests.md",         search = 'rkt = \{ version = "[0-9][0-9A-Za-z.-]*"',          replace = 'rkt = { version = "{{version}}"' },
+  { file = "../../contrib/ws/README.md",                search = 'package = "rkt_ws", version = "[0-9][0-9A-Za-z.-]*"', replace = 'package = "rkt_ws", version = "{{version}}"' },
+  { file = "../../contrib/dyn_templates/README.md",     search = 'version = "[0-9][0-9A-Za-z.-]*"',                   replace = 'version = "{{version}}"' },
+  { file = "src/lib.rs",                                search = 'rkt = \{ package = version = "[0-9][0-9A-Za-z.-]*"', replace = 'rkt = { package = version = "{{version}}"' },
+  { file = "src/lib.rs",                                search = 'rkt = \{ version = "[0-9][0-9A-Za-z.-]*"',          replace = 'rkt = { version = "{{version}}"' },
+  { file = "src/listener/quic.rs",                      search = 'rkt = \{ version = "[0-9][0-9A-Za-z.-]*"',          replace = 'rkt = { version = "{{version}}"' },
+  { file = "src/serde/json.rs",                         search = '\[dependencies\.rkt\]\n//! version = "[0-9][0-9A-Za-z.-]*"', replace = '''[dependencies.rkt]
+//! version = "{{version}}"''' },
+  { file = "src/serde/msgpack.rs",                      search = '\[dependencies\.rkt\]\n//! version = "[0-9][0-9A-Za-z.-]*"', replace = '''[dependencies.rkt]
+//! version = "{{version}}"''' },
+  { file = "src/serde/uuid.rs",                         search = '\[dependencies\.rkt\]\n//! version = "[0-9][0-9A-Za-z.-]*"', replace = '''[dependencies.rkt]
+//! version = "{{version}}"''' },
+  { file = "../codegen/src/lib.rs",                     search = 'rkt = \{ version = "[0-9][0-9A-Za-z.-]*"',          replace = 'rkt = { version = "{{version}}"' },
+]
+
 [lints]
 workspace = true
 

core/lib/src/lib.rs

@@ -25,7 +25,7 @@
 //!
 //! ```toml
 //! [dependencies]
-//! rkt = { package = version = "1.0.0" }
+//! rkt = { package = version = "1.1.0" }
 //! ```
 //!
 //! See the [guide](https://rkt.rs/guide) for more information on how
@@ -69,14 +69,14 @@
 //!
 //! ```toml
 //! [dependencies]
-//! rkt = { version = "1.0.0", features = ["secrets", "tls", "json"] }
+//! rkt = { version = "1.1.0", features = ["secrets", "tls", "json"] }
 //! ```
 //!
 //! Conversely, HTTP/2 can be disabled:
 //!
 //! ```toml
 //! [dependencies]
-//! rkt = { version = "1.0.0", default-features = false }
+//! rkt = { version = "1.1.0", default-features = false }
 //! ```
 //!
 //! [subscriber]: crate::trace::subscriber

core/lib/src/listener/quic.rs

@@ -6,7 +6,7 @@
 //! ```toml
 //! // Add the following to your Cargo.toml:
 //! [dependencies]
-//! rkt = { version = "1.0.0", features = ["http3-preview"] }
+//! rkt = { version = "1.1.0", features = ["http3-preview"] }
 //!
 //! // In your Rocket.toml or other equivalent config source:
 //! [default.tls]

core/lib/src/serde/json.rs

@@ -9,7 +9,7 @@
 //!
 //! ```toml
 //! [dependencies.rkt]
-//! version = "1.0.0"
+//! version = "1.1.0"
 //! features = ["json"]
 //! ```
 //!

core/lib/src/serde/msgpack.rs

@@ -8,8 +8,8 @@
 //! it in `Cargo.toml` as follows:
 //!
 //! ```toml
-//! [dependencies.rocket]
-//! version = "1.0.0"
+//! [dependencies.rkt]
+//! version = "1.1.0"
 //! features = ["msgpack"]
 //! ```
 //!

core/lib/src/serde/uuid.rs

@@ -6,8 +6,8 @@
 //! in `Cargo.toml` as follows:
 //!
 //! ```toml
-//! [dependencies.rocket]
-//! version = "1.0.0"
+//! [dependencies.rkt]
+//! version = "1.1.0"
 //! features = ["uuid"]
 //! ```
 //!

release.toml

@@ -0,0 +1,14 @@
+# cargo-release configuration.
+#
+# `Cargo.toml` (workspace.package.version) is the single source of truth for the
+# rkt version; every crate inherits it via `version.workspace = true`. The
+# documented version strings (READMEs, website, guide) are kept in lockstep by
+# `pre-release-replacements`, defined under [package.metadata.release] in
+# core/lib/Cargo.toml so they run exactly once (cargo-release otherwise applies
+# workspace-level replacements once per crate, resolving paths per-crate).
+#
+# Release a new version with, e.g.:  cargo release 1.0.2 --execute
+# (omit --execute for a dry run).
+
+# Bump every crate in the workspace together.
+shared-version = true

website/docs/02-getting-started.md

@@ -38,7 +38,7 @@ Now, add rkt as a dependency in your `Cargo.toml`:
 
 ```toml
 [dependencies]
-rkt = "1.0.1"
+rkt = "1.1.0"
 ```
 
 Modify `src/main.rs` so that it contains the code for the rkt `Hello, world!`

website/docs/04-requests.md

@@ -667,7 +667,7 @@ feature:
 
 ```toml
 ## in Cargo.toml
-rkt = { version = "1.0.1", features = ["secrets"] }
+rkt = { version = "1.1.0", features = ["secrets"] }
 ```
 
 The API for retrieving, adding, and removing private cookies is identical except
@@ -847,7 +847,7 @@ docs](https://docs.rs/rkt/latest/rkt/#features) for a list of available features
 feature can be enabled in the `Cargo.toml`:
 
 ```toml
-rkt = { version = "1.0.1", features = ["json"] }
+rkt = { version = "1.1.0", features = ["json"] }
 ```
 :::
 

website/docs/10-configuration.md

@@ -250,7 +250,7 @@ Security). To enable TLS support:
 
      ```toml,ignore
      [dependencies]
-     rkt = { version = "1.0.1", features = ["tls"] }
+     rkt = { version = "1.1.0", features = ["tls"] }
      ```
 
   2. Configure a TLS certificate chain and private key via the `tls.key` and
@@ -326,7 +326,7 @@ enabled and support configured via the `tls.mutual` config parameter:
 
    ```toml,ignore
    [dependencies]
-   rkt = { version = "1.0.1", features = ["mtls"] }
+   rkt = { version = "1.1.0", features = ["mtls"] }
    ```
 
    This implicitly enables the `tls` feature.

website/docs/12-pastebin.md

@@ -58,7 +58,7 @@ Then add the usual rkt dependencies to the `Cargo.toml` file:
 
 ```toml
 [dependencies]
-rkt = "1.0.1"
+rkt = "1.1.0"
 ```
 
 And finally, create a skeleton rkt application to work off of in

website/docs/14-faq.md

@@ -641,7 +641,7 @@ is to depend on a `contrib` library from git while also depending on a
 `crates.io` version of Rocket or vice-versa:
 
 ```toml
-rkt = { version = "1.0.1" }
+rkt = { version = "1.1.0" }
 rkt_dyn_templates = { git = "https://github.com/rustfoo/rkt.git" }
 ```
 

website/docs/index.md

@@ -6,7 +6,7 @@ sidebar_position: 1
 
 Welcome to rkt!
 
-This is the official guide for rvt v1.0.0. It is designed to serve as a
+This is the official guide for rkt v1.1.0. It is designed to serve as a
 starting point to writing web applications with rkt and Rust.
 
 The guide is also designed to be a reference for experienced Rocket developers.

website/src/pages/index.js

@@ -179,7 +179,7 @@ function QuickStart() {
             </Link>
           </div>
           <div className={styles.quickStartCode}>
-            <CodeBlock language="toml" title="Cargo.toml">{`[dependencies]\nrkt = "1.0.0"`}</CodeBlock>
+            <CodeBlock language="toml" title="Cargo.toml">{`[dependencies]\nrkt = "1.1.0"`}</CodeBlock>
             <CodeBlock language="rust" title="src/main.rs">{TYPED_EXAMPLE}</CodeBlock>
           </div>
         </div>