Expand description
release-kit: a canonical release workflow, carried whole by one binary.
The library exists so the crate’s own tests can link the modules; the
rk binary in main.rs is the product. embedded holds the embedded
sources and distribution_roots their one inventory, cli the
argument surface, commands the handlers, projection the one pure
candidate tree over the embedded sources, landing the parameters and
the direct writes into a target, stage the disposable candidate
stage over the projection, self_depend the consumer pin, depend
the dependency matrix, skills the user-scope skill install, digest
the one hash type, and error the one exit-code matrix.
Modules§
- applog
- The application log: one rotating file for the whole binary.
- assess
- Classify a target repository before anything lands.
- atomic
- The temp-plus-rename writer every landing write goes through, and the staged transaction an apply commits several writes through.
- branches
- Local-branch hygiene after squash merges.
- cargo_
package - What one Cargo package ships, read from
cargo package --list. - cli
- Command-line surface: clap derive types only, one module per
subcommand’s arguments. No behavior lives here; each variant routes to
its handler in
commands. - commands
- One handler per subcommand. Handlers hold the behavior;
mainonly dispatches, andclionly declares the argument surface. - config
- The committed target configuration, parsed strictly and written from authored text, typed by the domain that owns each answer. Comparisons continue to use the landing record alone.
- depend
rk depend: another project as a dependency of a target, from how the source distributes itself and how the target manages its tools.- detect
- Forge, repository, and technology detection.
- diagnostic
- Diagnostics as data: the closed reason vocabulary and the typed error report.
- digest
- SHA-256 digests in their hex text form.
- distribution_
roots - embedded
- The embedded sources: everything the binary serves or lands, compiled in.
- error
- Crate-level error type and exit-code mapping.
- events
- The NDJSON event envelope for long-running commands.
- integrate
- The pure half of
rk integrate: the transaction’s judgments and the evidence a local integration leaves behind. - issue
- Starting work from a forge issue: the pure half.
- landing
- The target-side landing model: parameter resolution, what a target currently holds, and the direct writes.
- maintenance
- The shared process-side discipline of local-resource cleanup.
- output
- The output boundary every handler emits through.
- probes
- The environment probe catalog.
- profile
- The resolved target configuration.
- projection
- The one pure target-specific projection over this binary’s embedded sources.
- registry
- The pinned-tool registry, parsed from the embedded
versions.toml. - self_
depend rk self-depend: release-kit as a consumer project’s development dependency, kept fresh.- setup
- The executable half of
method/02-setup.md. - skills
- The agent skills: the embedded files, the user-scope record, and the installer.
- stage
- The candidate stage: this binary’s projection for one target, materialized on disk beside the knowledge that explains it.
- worktree
- Worktree hygiene after squash merges: the pure half.