bake-readme

Reusable readme.md maintenance tasks for Bake. readme:update keeps the short release summary and package links in a project's readme.md up to date.

Motivation

A project's readme.md should help people quickly understand what the project does, why it exists, and where to start. Release summaries and package links are useful, but they are easy to forget or leave stale when maintained by hand. Bake Readme refreshes those derived sections while leaving the project's explanation and examples under its authors' control.

Usage

Add this crate to the project's private Bake task executable and link its task library:

[dependencies]
bake-readme = "0.2"

use bake_readme as _;

Then run the task from the project root:

cargo bake readme:update

If readme.md has no authored Releases section, the task adds one with the three latest versioned entries from releases.md. It skips Unreleased and links to the full release history. The task also adds or refreshes a package entry in See Also based on the root Cargo.toml name, description, and repository URL. Existing authored sections and entries are preserved.

A custom path is supported with --path PATH.

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 for the standard process.

Releases

See releases.md for the full release history.

v0.2.3

• Adopt socketry-project 0.3.7 for shared project tasks and Markdown normalization.
• Require the aggregate test and coverage result for pull request merges.
• Refresh dependency examples and repository-owned agent guidance.

v0.2.2

• Keep the Bake dependency open-ended from 0.18 so task libraries share their project's active task registry.

v0.2.1

• Require Bake 0.18.0 for the shared task registry.

Contributing

Please open an issue or pull request on GitHub. The readme guidance describes the intended scope and structure of project readme.md files.

Agent Context

Run cargo bake agent:context:install to install shared context and skills. Read .agents/context/index.md to find relevant guides, follow agents.md if present, and apply skills under .agents/skills/. The installer preserves repository-owned agents.md; it does not create or regenerate that file.