Skip to main content

Crate oakum

Crate oakum 

Source
Expand description

Release planning across package ecosystems.

The planner is a pure function from intent (change files or conventional commits) plus a discovered workspace to a release plan. Everything that touches the filesystem, a registry, or GitHub lives outside it, so the cascade math can be tested against recorded history without side effects.

Modules are named for the crates they would become if this is ever split; see docs/contributing/structure.md for what would trigger that.

Modules§

changeset
Change files: the changeset-format intersection and directory reading rules.
commits
Map conventional (and plain) commit messages to package bump intent.
config
_config.toml schema: kebab-case keys, unknown fields refused (ADR-0004 / ADR-0007).
detect
Detect another release tool so init can name migrate (okm-0s5).
discover
Workspace discovery.
manifest
In-memory manifest and lockfile edits. Filesystem writes belong to version (ADR-0003).
plan
Release planning: intent plus a discovered workspace to a set of version changes.
prettier_json
JSON that Prettier 3 leaves unchanged with its defaults, so a generated file survives a repository’s formatter (ADR-0031’s goal for generated markdown, applied to _schema.json). Objects are always expanded, which Prettier preserves because the first key starts on its own line; arrays follow its print-width and fill rules. That is a fixed point of the formatter, not a reproduction of it: a short object Prettier would print on one line from other input stays expanded here. tests/it/prettier_oracle.rs runs the real formatter over the output as the gate.
state
Versioned release state for status --json, templates, and PR surfaces (ADR-0016).
tags
Resolve git tag names to (package, version) without talking to git.
template
User-owned templates: they render, they do not execute (ADR-0006).