From 0a2127cc6da8eca438410976c7109c271bd4a0c1 Mon Sep 17 00:00:00 2001 From: Samuel Williams Date: Tue, 6 Oct 2026 11:12:06 +1300 Subject: [PATCH 1/2] Align Rust crate interfaces and project guidance. --- Cargo.lock | 24 +++++++++++++++++------- bake/src/bake_generated_tasks/mod.rs | 4 +--- readme.md | 17 +++++++++-------- releases.md | 4 ++++ 4 files changed, 31 insertions(+), 18 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 79d7a35..f1061a9 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -31,15 +31,15 @@ dependencies = [ [[package]] name = "bake-agent-context" -version = "0.3.0" +version = "0.3.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "386910c08614146515e754bf6208aedba73abdb9a2767e8bd5c2d997845c84ef" +checksum = "9d0559ad6c6b640ec182f6378ca77825c4327f7b4fce65cfa84e47e25a1bfcb5" dependencies = [ "bake", "serde", "serde_json", "serde_yaml_ng", - "socketry-markdown 0.1.1", + "socketry-markdown 0.2.0", ] [[package]] @@ -101,9 +101,9 @@ dependencies = [ [[package]] name = "bake-readme" -version = "0.2.2" +version = "0.2.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7f9ab6aa18fb34ab56c06cb49d87f7eb19cd6bfe16d8553856fbdd6380f39634" +checksum = "48b3733cc48991e6482c04b4997db89f75a7200e2c546c73047bd24e323c3f2a" dependencies = [ "bake", "serde_json", @@ -124,9 +124,9 @@ dependencies = [ [[package]] name = "bake-test-rust" -version = "0.3.0" +version = "0.3.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e9d5ceec9cc08a3bb421dd3755ad9e073831934793aa88d8f55095ad98c1dc45" +checksum = "3ced0bd0b0ae3f8df4b3cbb03b2a98080a5a9504c6b758c3eb96929dfd3dae93" dependencies = [ "bake", "serde_json", @@ -661,6 +661,16 @@ dependencies = [ "unicode-id", ] +[[package]] +name = "socketry-markdown" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "37d3a646262edeca60e86e4c4dd493167e74beb03ea75a60b2d5c40e6d6d8c5b" +dependencies = [ + "regex", + "unicode-id", +] + [[package]] name = "socketry-markdown" version = "0.3.0" diff --git a/bake/src/bake_generated_tasks/mod.rs b/bake/src/bake_generated_tasks/mod.rs index 0ddfa03..860794b 100644 --- a/bake/src/bake_generated_tasks/mod.rs +++ b/bake/src/bake_generated_tasks/mod.rs @@ -1,6 +1,4 @@ -// Released under the MIT License. -// Copyright, 2026, by Samuel Williams. - // Generated by `cargo bake --regenerate`; do not edit. + use bake_markdown as _; use socketry_project as _; diff --git a/readme.md b/readme.md index f54d6a8..436d6dd 100644 --- a/readme.md +++ b/readme.md @@ -8,15 +8,12 @@ Hard-wrapped paragraphs are difficult to edit consistently. This crate uses the ## Usage -Add the crate to the project's private `bake/` package and link its tasks: +Add the crate to the project's private `bake/` package and regenerate its task links: -```toml -[dependencies] -bake-markdown = "0.3" -``` - -```rust,ignore -use bake_markdown as _; +```sh +cargo bake --regenerate +cargo add --manifest-path bake/Cargo.toml bake-markdown +cargo bake --regenerate ``` Normalize one or more files relative to the project root: @@ -27,6 +24,10 @@ cargo bake markdown:normalize readme.md context/guide.md Rust callers can use `bake_markdown::normalize_document` directly. +## Releasing + +Prepare a release with `cargo bake cargo:version:patch` (or `minor`, `major`, or `bump --version X.Y.Z`), then run `cargo bake cargo:release` and open a pull request. After review and merge, GitHub Actions publishes the release when the configured `crates-io` environment approves it. Follow the shared [Releasing skill](https://github.com/socketry/socketry-project-rust/blob/main/context/releasing.md) for the standard process. + ## Releases diff --git a/releases.md b/releases.md index d07d692..67d4a64 100644 --- a/releases.md +++ b/releases.md @@ -1,5 +1,9 @@ # Releases +## Unreleased + +- Document the shared release process. + ## v0.3.1 - Resolve development task dependencies to the current checkout. From a4a9dcbe457ae706b20da8af1b837273f0f6f940 Mon Sep 17 00:00:00 2001 From: Samuel Williams Date: Tue, 6 Oct 2026 11:12:08 +1300 Subject: [PATCH 2/2] Prepare the consistency release. --- Cargo.lock | 2 +- Cargo.toml | 2 +- bake/src/bake_generated_tasks/mod.rs | 4 +++- readme.md | 8 ++++---- releases.md | 2 +- 5 files changed, 10 insertions(+), 8 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index f1061a9..ac72833 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -83,7 +83,7 @@ dependencies = [ [[package]] name = "bake-markdown" -version = "0.3.1" +version = "0.3.2" dependencies = [ "bake", "socketry-markdown 0.3.0", diff --git a/Cargo.toml b/Cargo.toml index 25a6903..2a21522 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "bake-markdown" -version = "0.3.1" +version = "0.3.2" edition = "2024" rust-version = "1.85" license = "MIT" diff --git a/bake/src/bake_generated_tasks/mod.rs b/bake/src/bake_generated_tasks/mod.rs index 860794b..0ddfa03 100644 --- a/bake/src/bake_generated_tasks/mod.rs +++ b/bake/src/bake_generated_tasks/mod.rs @@ -1,4 +1,6 @@ -// Generated by `cargo bake --regenerate`; do not edit. +// Released under the MIT License. +// Copyright, 2026, by Samuel Williams. +// Generated by `cargo bake --regenerate`; do not edit. use bake_markdown as _; use socketry_project as _; diff --git a/readme.md b/readme.md index 436d6dd..46405dd 100644 --- a/readme.md +++ b/readme.md @@ -34,6 +34,10 @@ Prepare a release with `cargo bake cargo:version:patch` (or `minor`, `major`, or See [releases.md](releases.md) for the full release history. +### v0.3.2 + +- Document the shared release process. + ### v0.3.1 - Resolve development task dependencies to the current checkout. @@ -48,10 +52,6 @@ See [releases.md](releases.md) for the full release history. - Normalize unordered Markdown lists with hyphen markers. -### v0.2.0 - -- Accept Markdown paths as positional arguments to `markdown:normalize`. - ## See Also diff --git a/releases.md b/releases.md index 67d4a64..2f1194e 100644 --- a/releases.md +++ b/releases.md @@ -1,6 +1,6 @@ # Releases -## Unreleased +## v0.3.2 - Document the shared release process.