194 lines
7.0 KiB
YAML
194 lines
7.0 KiB
YAML
apiVersion: devrunbook.io/v1alpha1
|
|
kind: Playbook
|
|
metadata:
|
|
id: release-operations.release-notes
|
|
slug: release-notes
|
|
version: 1.0.0
|
|
title: Generate Evidence-Based Release Notes
|
|
summary: Create concise release notes from verified changes, migrations, fixes, known limitations and operator actions.
|
|
category: release-operations
|
|
tags:
|
|
- release-notes
|
|
- documentation
|
|
- changelog
|
|
lifecycle: reviewed
|
|
riskTier: low
|
|
authors:
|
|
- name: DevRunbook Core Team
|
|
license: MIT
|
|
package:
|
|
files:
|
|
- path: prompt.md
|
|
role: template
|
|
digest: true
|
|
exportByDefault: false
|
|
- path: README.md
|
|
role: documentation
|
|
digest: true
|
|
exportByDefault: false
|
|
- path: CHANGELOG.md
|
|
role: changelog
|
|
digest: true
|
|
exportByDefault: false
|
|
- path: examples/minimal.yaml
|
|
role: example
|
|
digest: true
|
|
exportByDefault: false
|
|
- path: evaluations/static-structure.yaml
|
|
role: evaluation
|
|
digest: true
|
|
exportByDefault: false
|
|
spec:
|
|
type: quick
|
|
intent:
|
|
problem: Development work around generate evidence-based release notes is often underspecified, inconsistently executed
|
|
or reported without enough evidence.
|
|
outcome: Create concise release notes from verified changes, migrations, fixes, known limitations and operator actions.
|
|
whenToUse:
|
|
- Use this playbook when the repository needs a bounded generate evidence-based release notes task with explicit evidence
|
|
and completion criteria.
|
|
- Use it when Codex should follow a repeatable workflow rather than improvise from a one-line request.
|
|
whenNotToUse:
|
|
- Do not use it when the desired outcome or authority boundaries are still materially undecided.
|
|
- Do not use it to access unavailable production credentials, bypass safeguards or claim validation that cannot be performed.
|
|
modes:
|
|
- guided
|
|
defaultMode: guided
|
|
autonomy:
|
|
min: plan
|
|
max: verify
|
|
default: plan
|
|
inputs:
|
|
- key: releaseRange
|
|
label: Release range
|
|
description: Identify the commits, tags or previous release that define the change range.
|
|
type: string
|
|
required: true
|
|
sensitive: false
|
|
includeInOutput: true
|
|
- key: audience
|
|
label: Audience
|
|
description: Choose the intended reader for the release notes.
|
|
type: enum
|
|
required: true
|
|
sensitive: false
|
|
includeInOutput: true
|
|
default: operators-and-users
|
|
options:
|
|
- end-users
|
|
- operators
|
|
- developers
|
|
- operators-and-users
|
|
compatibility:
|
|
repositoryRequired: true
|
|
languages: []
|
|
frameworks: []
|
|
packageManagers: []
|
|
databases: []
|
|
deploymentTypes: []
|
|
requiredProfileCapabilities: []
|
|
incompatibleConditions: []
|
|
guardrails:
|
|
- id: guardrail-1
|
|
severity: blocking
|
|
text: Base notes on repository evidence and the requested release range.
|
|
- id: guardrail-2
|
|
severity: blocking
|
|
text: Do not claim fixes, migrations or compatibility that cannot be verified.
|
|
- id: guardrail-3
|
|
severity: blocking
|
|
text: Separate user-facing changes, operator actions and developer details.
|
|
workflow:
|
|
- id: collect-range
|
|
title: Collect release evidence
|
|
instruction: Inspect commits, merged changes, issues, changelog fragments and migrations in the selected range.
|
|
required: true
|
|
- id: classify
|
|
title: Classify changes
|
|
instruction: Group features, fixes, security, operations, deprecations and breaking changes.
|
|
required: true
|
|
- id: identify-actions
|
|
title: Identify required actions
|
|
instruction: Extract upgrade, migration, configuration and rollback implications.
|
|
required: true
|
|
- id: draft-notes
|
|
title: Draft audience notes
|
|
instruction: Write concise notes in product language for the selected audience.
|
|
required: true
|
|
- id: verify-links
|
|
title: Verify references
|
|
instruction: Check identifiers, versions and evidence links and remove unsupported claims.
|
|
required: true
|
|
- id: finalize
|
|
title: Finalize artifact
|
|
instruction: Produce release notes plus a concise known-limitations section.
|
|
required: true
|
|
validation:
|
|
commandRoles: []
|
|
checks:
|
|
- id: check-1
|
|
type: assertion
|
|
description: Every material note is traceable to repository evidence.
|
|
blocking: true
|
|
evidence: Referenced files, command results or explicit review notes.
|
|
- id: check-2
|
|
type: assertion
|
|
description: Breaking changes and required operator actions are prominent.
|
|
blocking: true
|
|
evidence: Referenced files, command results or explicit review notes.
|
|
completion:
|
|
criteria:
|
|
- Notes match actual changes and validation evidence.
|
|
- Operator actions and breaking changes are prominent.
|
|
- Validation evidence and unresolved limitations are reported honestly.
|
|
failurePolicy:
|
|
onValidationFailure: Investigate failures caused by the current work, repair them when they remain within scope, rerun
|
|
affected validation and report any genuine blocker without claiming success.
|
|
onAmbiguity: Use repository evidence and existing conventions for minor reversible choices. Preserve current behavior
|
|
and stop before any material irreversible decision that the specification does not resolve.
|
|
onMissingContext: Inspect the repository for missing non-sensitive context. Never invent commands, credentials, production
|
|
behavior or validation results; report what remains unavailable.
|
|
onOutOfScopeCause: Explain the evidenced out-of-scope cause, avoid unrelated changes and provide the smallest safe follow-up
|
|
recommendation.
|
|
onExternalDependencyUnavailable: Use an approved local substitute or fixture only when it preserves the behavior under
|
|
test. Otherwise record the blocked validation and do not claim the external path succeeded.
|
|
onUnableToReproduce: Record attempted reproduction, environment and observed evidence. Do not apply speculative production
|
|
changes; provide the narrowest next diagnostic action.
|
|
reporting:
|
|
sections:
|
|
- id: outcome
|
|
title: Outcome
|
|
required: true
|
|
description: State the delivered result or audit conclusion without overstating evidence.
|
|
- id: evidence
|
|
title: Evidence and scope
|
|
required: true
|
|
description: List inspected or changed areas and the evidence supporting the result.
|
|
- id: validation
|
|
title: Validation
|
|
required: true
|
|
description: Report commands, manual checks and their actual outcomes.
|
|
- id: risks
|
|
title: Risks and limitations
|
|
required: true
|
|
description: State residual risk, inaccessible evidence and untested conditions.
|
|
- id: follow-up
|
|
title: Recommended follow-up
|
|
required: true
|
|
description: List the smallest useful next actions or state None.
|
|
template:
|
|
main: prompt.md
|
|
partials: []
|
|
exports:
|
|
prompt: true
|
|
markdown: true
|
|
runPack: false
|
|
agentsSuggestion: false
|
|
quality:
|
|
reviewStatus: editorial-reviewed
|
|
testedStacks: []
|
|
knownLimitations:
|
|
- Repository-specific effectiveness depends on the accuracy of the selected profile and the evidence available to Codex.
|
|
evaluationCaseIds:
|
|
- release-notes.static-structure
|