socketry-project 0.2.7

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.

Install dependency context and skills with cargo bake agent:context:install. This writes a generated index at .agents/context/index.md, leaves the repository owner's agents.md untouched, and installs the socketry-project-setup, socketry-project-github-repository, and socketry-project-pull-requests skills under .agents/skills/.

See the repository setup skill for the minimal Cargo configuration and the conventions for repository layout, documentation, and code conventions. The Rust Repository Layout and Rust Testing guides provide more detail on source organization and test workflows.

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, then creates or updates the matching GitHub Release from releases.md. See the Cargo publishing guide.

Releases

See releases.md for the full release history.

v0.2.7

  • Clarify how context installation uses .agents/context/index.md and local Git exclusions without changing a repository-owned agents.md.
  • Express shared task dependencies as minimum versions so compatible updates can be selected by the host project's lockfile.
  • Require 100% line coverage for workspace targets in GitHub Actions.
  • Use the shared bake-test-rust coverage task in the standard workflow.
  • Cover Bake task execution and the version-bump hook's task ordering.

v0.2.6

  • Support bake-agent-context 0.2 while retaining compatibility with 0.1.
  • Keep the generated context index under .agents/context/ without modifying the repository owner's agents.md.

v0.2.5

  • Distribute repository setup, GitHub setup, and pull request guidance as installable skills.
  • Provide shared Agent Context guidance through bake-agent-context.

See Also

  • socketry-project — Shared project conventions and development tasks for Socketry Rust crates

Contributing

Please open an issue or pull request on GitHub.

Agent Context

Before contributing, follow agents.md if present, then read the relevant context files linked from .agents/context/index.md and applicable skills under .agents/skills/. If the index or installed skills are missing or out of date, run cargo bake agent:context:install to refresh context and skills from dependencies. See the Agent Context guide for guidance on organizing package context and repository-only instructions.