`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

Add socketry-project to the dependencies of your private bake/ package:

# bake/Cargo.toml
[dependencies]
bake = "0.17"
socketry-project = "0.2"

Link the tasks from bake/src/main.rs:

use bake::{Registry, Result};
use socketry_project as _;

fn main() -> Result<()> {
    Registry::discover()?.run()
}

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.

Agent Context

Install Bake once, then install all context documents provided by the resolved Cargo dependencies:

cargo install socketry-cargo-bake --locked
cargo bake agent:context:install

The command copies every dependency's context/ guides into .agents/context/ and updates agents.md with links to those guides. Read agents.md, then open the relevant context files before continuing work. This crate provides Socketry project guidance, while its Bake dependencies provide focused guidance for Cargo publishing, licenses, Readmes, releases, and agent context. The no-argument install command discovers context from all resolved dependency crates used by the workspace.

The generated .agents/context/ directory is ignored by Git and can be refreshed by running the install task again after dependency updates. To install only this crate's guides, use cargo bake agent:context:install --package socketry-project.

See Agent Context for guidance on writing and organizing context for a project.

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

v0.1.0

Establish shared conventions and standard Bake tasks for Socketry Rust projects.
Document project layout, GitHub setup, and agent context installation.

Contributing

Please open an issue or pull request on GitHub.

socketry-project 0.2.0