Skip to content

About

Shared project conventions and development tasks for Socketry Rust crates

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

48 Commits

Folders and files

Repository files navigation

core-project

Shared conventions and development tasks for Rust projects in the core-rs 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

If socketry-cargo-bake is installed, run cargo uninstall socketry-cargo-bake first. Both packages provide the cargo-bake binary.

Install the launcher and create the private task package:

cargo install bake --locked
cargo bake --regenerate

Let Cargo select the current dependency version:

cargo add --manifest-path bake/Cargo.toml core-project

In bake/Cargo.toml, prefix the version selected by Cargo with >= to make it an open-ended minimum. Keep that actual minimum in the manifest and the resolved version in Cargo.lock; the setup documentation does not need a copy of either version.

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. The open-ended minimum requirement keeps this development dependency eligible for newer releases. Cargo.lock records the selected version for reproducible builds; update it deliberately when adopting a newer release.

This adds the standard Cargo, release, license, Readme, Markdown, 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 for task and workflow details.

Releasing

Prepare a release with cargo bake cargo:version:patch (or minor, major, or bump --version X.Y.Z), commit with a Release: vVERSION Git trailer, 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 shared Releasing skill for the standard release process.

Releases

See releases.md for the full release history.

v0.2.0

  • Use core-markdown throughout the shared task stack.
  • Adopt the new agent-context installer and metadata.type: skill declarations. Discover guidance with agent:context:list and agent:context:show; the index and separate skill tasks are no longer available.

v0.1.0

  • Publish as core-project in the core-rs organization, with version numbering restarted at 0.1.0.
  • Require a Release: vVERSION Git trailer on the final release commit; version changes alone no longer trigger publication.

See Also

Contributing

Please open an issue or pull request on GitHub.

Agent Context

Run cargo bake agent:context:install to install shared context and skills. Use cargo bake agent:context:list and cargo bake agent:context:show to discover relevant guides, follow agents.md if present, and apply skills under .agents/skills/. The installer preserves repository-owned agents.md; it does not create or regenerate that file.

About

Shared project conventions and development tasks for Socketry Rust crates

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages