Operations pillar · v0.16.0

release-record ReleaseRecord

Software release.

$id · https://corpospec.com/schemas/v0.16.0/release-record.schema.json

Fields

Field Type Required Description
artefact_ref PathRef yes PathRef to the immutable artefact (Docker tag, npm tarball, crate sha).
changelog ReleaseChangelogEntry[] yes
channel ReleaseChannel yes Release channel.
git_ref string yes PathRef to the git tag / commit.
id PathRef yes Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$`
migration_required boolean yes Whether deployment requires migration steps.
product PathRef yes Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$`
release_manager PathRef yes Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$`
released_at IsoDate yes ISO 8601 date (YYYY-MM-DD).
security_review_status SecurityReviewStatus yes Security-review status.
status ReleaseStatus yes Release lifecycle.
version Semver yes Semantic version string (MAJOR.MINOR.PATCH).
bdr_refs PathRef[] PathRefs to BDRs / decisions covered by this release.
migration_runbook PathRef? PathRef to the migration runbook.
rollback_runbook PathRef? PathRef to the rollback runbook.
sbom_ref PathRef? PathRef to the SBOM attached to this release.
security_review_ref PathRef? PathRef to the security-review artefact.
signature_ref PathRef? Cryptographic signature (cosign / SLSA).

Definitions

Shared types referenced within this schema.

ChangeKind
Change kind (Keep a Changelog 1.1.0).
IsoDate
ISO 8601 date (YYYY-MM-DD).
type: string
PathRef
Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$`
pattern: ^[a-z0-9_-]+(/[a-z0-9_.-]+)+$
ReleaseChangelogEntry
One changelog entry.
type: object
ReleaseChannel
Release channel.
ReleaseStatus
Release lifecycle.
SecurityReviewStatus
Security-review status.
enum: "not_required", "pending", "passed", "passed_with_caveats", "failed"
Semver
Semantic version string (MAJOR.MINOR.PATCH).
pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$

Reference in your YAML

# yaml-language-server: $schema=https://corpospec.com/schemas/v0.16.0/release-record.schema.json