Generated from cat-harness/skills/process/workflow/release-lifecycle.md — do not edit here.

✎ Edit this page’s source

Release lifecycle — process and policy

This skill governs when and why to create releases. For the how (tagging, notes, gh release create), see ../../sdlc/sdlc-core/package-release.md.

Semver policy

folio-assistant follows Semantic Versioning 2.0.0:

Version partWhen to bumpExamples
Major (X.0.0)Breaking change to MCP tools, schema types, or public API. Requires downstream folios to update.Rename a block kind, remove a pipeline stage
Minor (0.X.0)New backward-compatible capability. New skills, tools, block kinds, BPMN workflows.Add a skill, add a docs page
Patch (0.0.X)Bug fix, typo, documentation correction, CI fix. No new capability.Fix a BPMN marker, fix a broken link

Release types and their gates

TypeGateWho decides
DraftFirst PR for a planned release mergesAgent creates, BA approves
Pre-release (RC)All must-have beans resolved, CI greenBA decides when to test
Named releaseStakeholder sign-off on the RCBA + stakeholders

Release planning with epics

A release epic groups all work for a specific release:

beans create "Release v0.5.0" --type epic
beans create "Add release lifecycle skill" --type story
beans update <story-id> --parent <epic-id>

Release readiness checklist

A release is ready when:

  • All must-have beans in the epic are resolved
  • CI is green on main
  • All changed docs pages regenerated and verified
  • All changed BPMNs re-rendered
  • Changelog is complete
  • BA has reviewed and approved

Where code review sits

Code review happens at the PR level (before merge to main). Release approval happens at the RC level (after many PRs merge).

PR → code review → merge → accumulate in draft release
                                    ↓
                         draft → RC → stakeholder test → named release

See code-review-process for the review detail.

Changelog format (Keep a Changelog)

## [X.Y.Z] — YYYY-MM-DD

### Added
- New `release-lifecycle` skill (#1340)

### Changed
- Updated CRDM workflow with Phase 4b prioritization (#1340)

### Fixed
- Added `isMarkerVisible` to BPMN gateways (#1340)

Derived from conventional commits:

  • feat: → Added
  • fix: → Fixed
  • docs: → Changed
  • BREAKING CHANGE: → ⚠ Breaking

Cross-domain applicability

Domain“Release”“RC”“Tag”
CodeGitHub releaseStaging deploymentGit tag
PaperPublication milestoneDraft circulationDOI assignment
ProjectDeliverable milestoneStakeholder review roundCompletion report

The process is identical; the artefacts differ.

Rules

  • Never create a release without BA approval
  • Never skip the pre-release step — even for patches
  • The changelog is written for humans — no commit hashes or bean IDs
  • One release per epic — if scope creeps, split the epic
  • Draft releases are mutable; named releases are immutable

Cross-references


folio-assistant — code under the Apache License 2.0, documentation under CC BY 3.0. Generated schema and API references are rebuilt from source on every push to main.

deployed dev