socketry-project 0.2.1

Shared project conventions and development tasks for Socketry Rust crates
Documentation

socketry-project

Shared conventions and development tasks for Rust projects in the Socketry organization.

Motivation

Rust projects should share a small set of clear conventions and a reliable release process without repeating task wiring in every repository.

Usage

Install the launcher and create the private task package:

cargo install socketry-cargo-bake --locked
cargo bake --regenerate

Add this dependency under the existing [dependencies] table in bake/Cargo.toml:

socketry-project = "0.2"

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.

This adds the standard Cargo, release, license, Readme, agent-context, and testing tasks, including test and test:external. It also registers a version-bump hook that updates the project's standard files.

See the project setup guide for the minimal Cargo configuration and the project conventions for repository layout, documentation, and code conventions. The Rust Project Layout and GitHub Repository Setup guides provide more detail. The Rust Testing guide describes the standard test workflow and optional downstream compatibility workflow.

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.2.1

  • Document setup and task linking with cargo bake --regenerate.

v0.2.0

  • Move the shared project tasks to bake 0.17 and include standard Rust test tasks.
  • Document standard local, downstream, and publishing workflows.

v0.1.1

  • Add a reusable Pull Requests guide to the packaged agent context.

Contributing

Please open an issue or pull request on GitHub.

Agent Context

Before contributing, read agents.md and the relevant context files it links. If agents.md is missing or out of date, run cargo bake agent:context:install to install context from dependencies and update the index. See Agent Context for guidance on writing and organizing context for a project.