From 729f159ca621146dd7d2a87c789b7da83aca4ae0 Mon Sep 17 00:00:00 2001 From: Samuel Williams Date: Tue, 6 Oct 2026 11:12:07 +1300 Subject: [PATCH 1/2] Align Rust crate interfaces and project guidance. --- Cargo.lock | 47 +++++++++++++--------------- Cargo.toml | 4 +-- bake/src/bake_generated_tasks/mod.rs | 4 +-- context/setup.md | 8 +++-- readme.md | 13 ++++++-- releases.md | 5 +++ 6 files changed, 44 insertions(+), 37 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 13490f0..8387c23 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]] @@ -93,9 +93,9 @@ dependencies = [ [[package]] name = "bake-readme" -version = "0.2.0" +version = "0.2.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9cbf2eb3710006c27705edd4186c53bc85bcca4fa80ea927a3718660e59833f2" +checksum = "48b3733cc48991e6482c04b4997db89f75a7200e2c546c73047bd24e323c3f2a" dependencies = [ "bake", "serde_json", @@ -116,9 +116,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", @@ -186,7 +186,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "39cab71617ae0d63f51a36d69f866391735b51691dbda63cf6f96d042b63efeb" dependencies = [ "libc", - "windows-sys 0.61.2", + "windows-sys", ] [[package]] @@ -514,7 +514,7 @@ dependencies = [ "getrandom 0.2.17", "libc", "untrusted", - "windows-sys 0.52.0", + "windows-sys", ] [[package]] @@ -527,7 +527,7 @@ dependencies = [ "errno", "libc", "linux-raw-sys", - "windows-sys 0.61.2", + "windows-sys", ] [[package]] @@ -655,6 +655,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" @@ -744,7 +754,7 @@ dependencies = [ "getrandom 0.4.3", "once_cell", "rustix", - "windows-sys 0.61.2", + "windows-sys", ] [[package]] @@ -878,12 +888,6 @@ dependencies = [ "rustls-pki-types", ] -[[package]] -name = "windows-link" -version = "0.2.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5" - [[package]] name = "windows-sys" version = "0.52.0" @@ -893,15 +897,6 @@ dependencies = [ "windows-targets", ] -[[package]] -name = "windows-sys" -version = "0.61.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ae137229bcbd6cdf0f7b80a31df61766145077ddf49416a728b02cb3921ff3fc" -dependencies = [ - "windows-link", -] - [[package]] name = "windows-targets" version = "0.52.6" diff --git a/Cargo.toml b/Cargo.toml index b6e6329..858904f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -23,11 +23,11 @@ name = "socketry_project" [dependencies] bake = ">=0.19.0" -bake-agent-context = { version = ">=0.2.0" } +bake-agent-context = { version = ">=0.3.2" } bake-cargo = { version = ">=0.4.0" } bake-license = { version = ">=0.1.1" } bake-markdown = { version = ">=0.3.0" } -bake-readme = { version = ">=0.1.1" } +bake-readme = { version = ">=0.2.3" } bake-releases = { version = ">=0.2.1" } bake-test-rust = { 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/context/setup.md b/context/setup.md index c3fe7bb..042a7e8 100644 --- a/context/setup.md +++ b/context/setup.md @@ -24,12 +24,14 @@ cargo install socketry-cargo-bake --locked cargo bake --regenerate ``` -The command creates `bake/`, adds it to the Cargo workspace, and writes a minimal binary. Add this dependency under the existing `[dependencies]` table in `bake/Cargo.toml`: +The command creates `bake/`, adds it to the Cargo workspace, and writes a minimal binary. Let Cargo select the current dependency version: -```toml -socketry-project = ">=0.3.6" +```sh +cargo add --manifest-path bake/Cargo.toml socketry-project ``` +In `bake/Cargo.toml`, prefix the version selected by Cargo with `>=` to make it an open-ended minimum. Keep that actual minimum in the manifest and the resolved version in `Cargo.lock`; the setup documentation does not need a copy of either version. + The open-ended minimum requirement allows newer `socketry-project` releases. The private Bake package's `Cargo.lock` records the selected version, so update the lockfile deliberately when adopting a newer release. Run regeneration again to link its task registrations: diff --git a/readme.md b/readme.md index ea1f24e..f0be0fe 100644 --- a/readme.md +++ b/readme.md @@ -15,12 +15,14 @@ cargo install socketry-cargo-bake --locked cargo bake --regenerate ``` -Add this dependency under the existing `[dependencies]` table in `bake/Cargo.toml`: +Let Cargo select the current dependency version: -```toml -socketry-project = ">=0.3.7" +```sh +cargo add --manifest-path bake/Cargo.toml socketry-project ``` +In `bake/Cargo.toml`, prefix the version selected by Cargo with `>=` to make it an open-ended minimum. Keep that actual minimum in the manifest and the resolved version in `Cargo.lock`; the setup documentation does not need a copy of either version. + Then run `cargo bake --regenerate` again to link the dependency's tasks. The command keeps generated links separate from task source, so no manual import in `main.rs` is needed. Run `cargo bake --list` to see the available tasks. The open-ended minimum requirement keeps this development dependency eligible for newer releases. `Cargo.lock` records the selected version for reproducible builds; update it deliberately when adopting a newer release. This adds the standard Cargo, release, license, Readme, Markdown, agent-context, and testing tasks, including `test` and `test:external`. It also registers a version-bump hook that updates the project's standard files. @@ -54,6 +56,11 @@ See [releases.md](releases.md) for the full release history. +## See Also + +- [`bake`](https://github.com/socketry/bake-rust). +- [`bake-test-rust`](https://github.com/socketry/bake-test-rust). + ## Contributing Please open an issue or pull request on [GitHub](https://github.com/socketry/socketry-project-rust). diff --git a/releases.md b/releases.md index 39c63bb..68c7712 100644 --- a/releases.md +++ b/releases.md @@ -1,5 +1,10 @@ # Releases +## Unreleased + +- Let Cargo select setup dependency versions while retaining open-ended minimum requirements. +- Require current agent-context and readme providers so installed guidance preserves repository instructions and shared conventions. + ## v0.3.7 - Require a stable aggregate test and coverage result alongside publishing checks. From b456f5aced206f336479780c70c12950be544eb0 Mon Sep 17 00:00:00 2001 From: Samuel Williams Date: Tue, 6 Oct 2026 11:12:09 +1300 Subject: [PATCH 2/2] Prepare the consistency release. --- Cargo.lock | 2 +- Cargo.toml | 2 +- bake/Cargo.toml | 2 +- bake/src/bake_generated_tasks/mod.rs | 4 +++- readme.md | 9 +++++---- releases.md | 2 +- 6 files changed, 12 insertions(+), 9 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 8387c23..84025c7 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -677,7 +677,7 @@ dependencies = [ [[package]] name = "socketry-project" -version = "0.3.7" +version = "0.3.8" dependencies = [ "bake", "bake-agent-context", diff --git a/Cargo.toml b/Cargo.toml index 858904f..ea8ff88 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "socketry-project" -version = "0.3.7" +version = "0.3.8" edition = "2024" license = "MIT" repository = "https://github.com/socketry/socketry-project-rust" diff --git a/bake/Cargo.toml b/bake/Cargo.toml index fc42ff0..f763eae 100644 --- a/bake/Cargo.toml +++ b/bake/Cargo.toml @@ -7,4 +7,4 @@ publish = false [dependencies] bake = "0.19.0" bake-markdown = "0.3.0" -socketry-project = { path = "..", version = "0.3.7" } +socketry-project = { path = "..", version = "0.3.8" } 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 f0be0fe..89e5b38 100644 --- a/readme.md +++ b/readme.md @@ -39,6 +39,11 @@ 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.8 + +- Let Cargo select setup dependency versions while retaining open-ended minimum requirements. +- Require current agent-context and readme providers so installed guidance preserves repository instructions and shared conventions. + ### v0.3.7 - Require a stable aggregate test and coverage result alongside publishing checks. @@ -50,10 +55,6 @@ See [releases.md](releases.md) for the full release history. - Fix the version bump hook's invocation of the Markdown normalizer. - Include `bake-markdown` 0.3.0 in the shared task set so version bumps use hyphen markers for unordered lists. -### v0.3.5 - -- Require `bake-test-rust` 0.3.0 or newer for LLVM region coverage and update the shared testing guidance to match. - ## See Also diff --git a/releases.md b/releases.md index 68c7712..3e60811 100644 --- a/releases.md +++ b/releases.md @@ -1,6 +1,6 @@ # Releases -## Unreleased +## v0.3.8 - Let Cargo select setup dependency versions while retaining open-ended minimum requirements. - Require current agent-context and readme providers so installed guidance preserves repository instructions and shared conventions.