Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 31 additions & 9 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,13 @@ reviewers = ["socketry/managers"]
name = "socketry_project"

[dependencies]
bake = ">=0.18.0"
bake = ">=0.19.0"
bake-agent-context = { version = ">=0.2.0" }
bake-cargo = { version = ">=0.4.0" }
bake-license = { version = ">=0.1.1" }
bake-readme = { version = ">=0.1.1" }
bake-releases = { version = ">=0.2.1" }
bake-test-rust = { version = ">=0.3.0" }

[dev-dependencies]
tempfile = "3"
3 changes: 2 additions & 1 deletion bake/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ edition = "2024"
publish = false

[dependencies]
bake = "0.18.0"
bake = "0.19.0"
bake-markdown = "0.2.0"
socketry-project = { path = "..", version = "0.3.5" }
5 changes: 2 additions & 3 deletions bake/src/bake_generated_tasks/mod.rs
Original file line number Diff line number Diff line change
@@ -1,5 +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 _;
2 changes: 2 additions & 0 deletions bake/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// Copyright, 2026, by Samuel Williams.

use bake::Registry;
use bake_markdown as _;
use std::process::ExitCode;

fn main() -> ExitCode {
Expand All @@ -27,6 +28,7 @@ mod tests {
assert!(names.contains(&"cargo:release"));
assert!(names.contains(&"cargo:after_version_bump"));
assert!(names.contains(&"license:update"));
assert!(names.contains(&"markdown:normalize"));
assert!(names.contains(&"readme:update"));
assert!(names.contains(&"releases:update"));
}
Expand Down
4 changes: 3 additions & 1 deletion context/conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,9 @@ their APIs into one shape.
`socketry-project` there so task tooling does not become a runtime dependency
of the published library.
- Use the `cargo:after_version_bump` hook registered by `socketry-project` to
update `license.md`, `releases.md`, and the generated sections of `readme.md`.
update `license.md`, `releases.md`, and the generated sections of `readme.md`,
then normalize those files and all Markdown under the public `context/`
directory.
- Follow the `socketry-project-releasing` skill to prepare and publish a
release. It links to Bake Cargo task documentation for workflow setup,
trusted publishing, reviewers, and tag creation.
10 changes: 6 additions & 4 deletions context/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,9 @@ cargo bake cargo:version:bump --version X.Y.Z
```

Choose one version task. The `socketry-project` hook updates `license.md`,
`releases.md`, and generated sections of `readme.md`. Review all generated
changes and ensure the release notes describe the actual changes.
`releases.md`, and generated sections of `readme.md`, then normalizes those
files and all Markdown under the public `context/` directory. Review the
generated changes and ensure the release notes describe the actual changes.

Run the project's required tests and coverage checks using the
`socketry-project-testing` skill. Commit the version and release files, then run
Expand Down Expand Up @@ -59,9 +60,10 @@ the version tag and creates or updates the matching GitHub Release from
`releases.md` using `cargo:releases:github:release`.

These operations are Bake tasks; the workflow contains no inline Python release
scripts. The task names in this workflow require `bake` 0.18.0 or newer and
scripts. The task names in this workflow require `bake` 0.19.0 and
`bake-cargo` 0.4.0 or newer in the resolved task binary, including its
`Cargo.lock`.
`Cargo.lock`. The version-bump hook also requires `bake-markdown` 0.2.0 or
newer.

After merging, check the workflow result, published package versions, version
tag, and GitHub Release. If a publish workflow is still waiting for environment
Expand Down
10 changes: 6 additions & 4 deletions context/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,9 @@ reviewers = ["socketry/managers"]
The `socketry-project` dependency makes the shared tasks available to the
private Bake binary. It also registers `cargo:after_version_bump`, which updates
`license.md`, `releases.md`, and generated sections in `readme.md` after a
version change.
version change, then normalizes those files and every Markdown file under the
public `context/` directory. Locally installed `.agents/context/` files are not
included.
Keep task tooling out of unrelated published libraries. Consumer projects
should depend on `socketry-project` from their private `bake/` package.

Expand Down Expand Up @@ -95,9 +97,9 @@ Use `cargo bake cargo:setup:workflow` to generate
workflow runs `cargo:release:detect` and `cargo:release` for release checks,
then `cargo:publish:pending` and `cargo:release:publish` after merge through
the configured `crates-io` environment. The standard workflow is documented in
the shared Releasing skill; its task binary must resolve `bake` 0.18.0 and
`bake-cargo` 0.4.0 or newer. Follow the `bake-test-rust` context for test
workflow and task details.
the shared Releasing skill; its task binary must resolve `bake` 0.19.0,
`bake-cargo` 0.4.0, and `bake-markdown` 0.2.0 or newer. Follow the
`bake-test-rust` context for test workflow and task details.

## Work on the project

Expand Down
4 changes: 4 additions & 0 deletions releases.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Releases

## Unreleased

- Normalize standard project Markdown files after version bumps.

## v0.3.5

- Require `bake-test-rust` 0.3.0 or newer for LLVM region coverage and update
Expand Down
Loading
Loading