Skip to main content

Module setup

Module setup 

Source
Expand description

The executable half of method/02-setup.md.

Rust owns everything except the forge call: step selection, ordering and prerequisite refusal, preview versus apply policy, detection, environment construction, exit-code classification, and the run journal. Each embedded script owns one forge-CLI invocation and the check it prints. Every mutating step follows one lifecycle — observe, compare, apply, verify — and preview, apply, and check are three callers of the same observe-and-verify code, with the mutating half unreachable from the read-only paths.

Modules§

app_jwt
Authenticating to the forge as the bot App itself.
branch_reminder
The post-merge reminder hook rk setup step branch-reminder writes.
context
The resolved context one setup run works in: target, repository, forge, the forge CLI binary, and the environment a step receives.
journal
The run journal: the audit record of one conversation with a forge.
observe
The observe-and-verify half of every step’s lifecycle.
process
The process adapter: the obligations a wrapper owes its child.
secrets
The bot credentials a setup step consumes, and what the operator’s environment is allowed to carry.
steps
The ordered step table: one step per executable item in method/02-setup.md, in the chapter’s order, each defined by what it proves rather than by how a forge achieves it.