bake-license 0.1.4

License and copyright maintenance tasks for Bake
Documentation

bake-license

bake-license provides a Bake task for maintaining the MIT license file and copyright headers in Rust projects.

Motivation

Updating license text and copyright headers by hand is repetitive. This task uses the repository's Git history to keep them consistent with its authorship.

Usage

Add bake-license to the private bake/ task package:

[dependencies]
bake-license = "0.1"

Regenerate task links and run the updater:

cargo bake --regenerate
cargo bake license:update

The task updates license.md and tracked Rust source headers, honoring .mailmap and .git-blame-ignore-revs. It skips bot accounts ending in [bot]. Existing Rust documentation comments are retained. Commit new files before running the task if they should receive copyright headers.

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. See the Cargo publishing guide.

Releases

See releases.md for the full release history.

v0.1.4

  • Preserve CRLF line endings when adding license headers to Rust source files.

v0.1.3

  • Preserve heading-like text inside HTML blocks when removing generated license sections.

v0.1.2

  • Create or update GitHub Releases after successful crates.io publication.
  • Keep release versioning tasks compatible with the current local crate.

See Also

  • Bake — composable development tasks for Rust projects.
  • socketry-project — shared project tasks and conventions for Socketry Rust crates.

Contributing

Please open an issue or pull request on GitHub.