Release Kit
A canonical release workflow: one technology-agnostic method, per-technology bindings, and the rk CLI that carries and lands both.
What this is
Two products in one repository. The method is what a reader loads: method/ states the five-stage spine, the invariants, and the recovery paths, and bindings/ states where rust, python, and bash differ. The distribution is what a project installs: the rk binary, built from src/, embeds the whole payload — the method, the bindings, the landable files under snippets/, the agent skills, and the pinned-tool registry — and lands the deterministic files with rk init.
The design in one sentence: work integrates on one trunk, a bot maintains one release pull request that bumps the version and the changelog, and merging it is the release that tags, publishes, and builds the artifacts.
Install
The binary is rk.
Quick paths
- Read the method: method/README.md, or
rk method --listanywhere. - Read a technology binding: bindings/, or
rk binding rust. - Land the workflow in a project:
rk init --tech rust --target .previews;--applywrites the files and the landing record. - Ask a landed project about itself:
rk status, with--checkfor a CI gate; take a newer payload withrk upgrade; record a pre-record project withrk adopt. - See the pinned tools and their freshness:
rk versions, andrk versions --checkto compare each pin upstream. - Prove what the binary carries:
rk payload, with--jsonfor the machine form. - Check the host and load the whole surface:
rk doctorandrk usage. - Install the agent skills at user scope:
rk skill installpreviews;--applywrites~/.claude/skills/and~/.agents/skills/, plus what they share at~/.local/state/release-kit/skills/shared/. - Follow the recipe:
rk guide setuponce per repository,rk guide releasefor every release,rk guide backportfor an older line. - Execute the repository-side setup:
rk setup --target .previews;--applyruns;rk setup checkproves it. - Read a forge's specifics:
rk forge githuborrk forge gitlab. - Audit what a setup run did:
rk runs listandrk runs show <id>. - Release this repository itself:
rk guidecarries the procedure; _docs/guides/release/ carries this repository's coordinates over it.
This repository dogfoods its own convention. The procedure lives in the shipped runbooks, served by rk guide; _docs/guides/release/ is this repository's overlay — the coordinates to export once, its deviations, and the transcript of a release cut end to end.
License
The method is under CC BY 4.0 and the distribution that lands it is under the MIT License. LICENSE states which side each file falls on, and rk license prints the terms the binary carries.