Skip to content

docs: document hotfix capability - #107

Merged
joshua-temple merged 1 commit into
mainfrom
docs/hotfix-capability
Jun 11, 2026
Merged

joshua-temple merged 1 commit into
mainfrom
docs/hotfix-capability

Conversation

@joshua-temple

Copy link
Copy Markdown
Collaborator

Problem

The hotfix capability has no user-facing documentation. The workflows.md hotfix section was a stale stub that referenced a placeholder issue number and described the pre-capability behavior.

Changes

  • docs/workflows.md: replaces the stub with full hotfix documentation covering the trunk-first roll-forward default, per-environment env/<env> integration branches, the cherry-pick and resolution-pull-request flow, conflict UX (markers committed, force-push to resolve), rejoin and cleanup, and the generated cascade-hotfix.yaml workflow (triggers, jobs, prod environment gating, env/* protection suggestions).
  • docs/versioning.md: adds the hotfix version segment, documenting both shapes: nested vX.Y.Z-rc.N.hotfix.M for rc-based bases and a normal patch bump for published bases.
  • docs/cli-reference.md: adds hotfix plan and hotfix finalize command references with flags, inputs, and outputs matching the implementation.

Verification

  • grep -riE 'cfa|dxe|delivery' docs/ returns clean.
  • Markdown well-formed; internal same-directory links resolve and match the existing convention.

Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
@joshua-temple
joshua-temple merged commit 2705ec2 into main Jun 11, 2026
8 checks passed
@joshua-temple joshua-temple added the docs Improvements or additions to documentation label Jun 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant