Skip to content

Latest commit

 

History

21 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 repository setup skill for the minimal Cargo configuration and the conventions for repository layout, documentation, and code conventions. The Rust Repository Layout explains source organization. The testing skill sets expectations and points to bake-test-rust for task and workflow details.

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

  • Add a testing skill that sets the 100% line-coverage expectation and directs agents to review uncovered code for semantic defects and use bake-test-rust for canonical workflows and task details.
  • Document how to maintain consistency across Socketry packages and record new semantic, layout, and naming patterns in the package that establishes them.

v0.3.0

  • Add an update skill for auditing and modernizing existing Socketry Rust projects.

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.

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

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/. See the Agent Context guide for guidance on organizing package context and repository-only instructions.

About

Shared project conventions and development tasks for Socketry Rust crates

Topics

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages