|
|
|
@@ -0,0 +1,236 @@
|
|
|
|
|
apiVersion: devrunbook.io/v1alpha1
|
|
|
|
|
kind: Playbook
|
|
|
|
|
metadata:
|
|
|
|
|
id: release-operations.clean-room-validation
|
|
|
|
|
slug: clean-room-validation
|
|
|
|
|
version: 1.0.0
|
|
|
|
|
title: Clean-Room Installation Validation
|
|
|
|
|
summary: Prove that a fresh clone or deployment can be installed, configured and exercised using only documented steps.
|
|
|
|
|
category: release-operations
|
|
|
|
|
tags:
|
|
|
|
|
- installation
|
|
|
|
|
- reproducibility
|
|
|
|
|
- deployment
|
|
|
|
|
lifecycle: reviewed
|
|
|
|
|
riskTier: moderate
|
|
|
|
|
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: run-pack
|
|
|
|
|
intent:
|
|
|
|
|
problem: Development work around clean-room installation validation is often underspecified, inconsistently executed or
|
|
|
|
|
reported without enough evidence.
|
|
|
|
|
outcome: Prove that a fresh clone or deployment can be installed, configured and exercised using only documented steps.
|
|
|
|
|
whenToUse:
|
|
|
|
|
- Use this playbook when the repository needs a bounded clean-room installation validation 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
|
|
|
|
|
- execute
|
|
|
|
|
- recovery
|
|
|
|
|
defaultMode: execute
|
|
|
|
|
autonomy:
|
|
|
|
|
min: implement
|
|
|
|
|
max: repair
|
|
|
|
|
default: verify
|
|
|
|
|
inputs:
|
|
|
|
|
- key: targetPlatform
|
|
|
|
|
label: Target platform
|
|
|
|
|
description: Select the primary platform on which the result must work or be verified.
|
|
|
|
|
type: enum
|
|
|
|
|
required: true
|
|
|
|
|
sensitive: false
|
|
|
|
|
includeInOutput: true
|
|
|
|
|
default: container
|
|
|
|
|
options:
|
|
|
|
|
- linux
|
|
|
|
|
- windows
|
|
|
|
|
- macos
|
|
|
|
|
- container
|
|
|
|
|
- unraid
|
|
|
|
|
- cross-platform
|
|
|
|
|
- key: smokeFlow
|
|
|
|
|
label: Smoke flow
|
|
|
|
|
description: Describe the smallest critical flow that proves the clean installation is usable.
|
|
|
|
|
type: multiline
|
|
|
|
|
required: true
|
|
|
|
|
sensitive: false
|
|
|
|
|
includeInOutput: true
|
|
|
|
|
compatibility:
|
|
|
|
|
repositoryRequired: true
|
|
|
|
|
languages: []
|
|
|
|
|
frameworks: []
|
|
|
|
|
packageManagers: []
|
|
|
|
|
databases: []
|
|
|
|
|
deploymentTypes: []
|
|
|
|
|
requiredProfileCapabilities:
|
|
|
|
|
- install-command
|
|
|
|
|
incompatibleConditions: []
|
|
|
|
|
guardrails:
|
|
|
|
|
- id: guardrail-1
|
|
|
|
|
severity: blocking
|
|
|
|
|
text: Do not reuse undeclared local dependencies, cached configuration or private files.
|
|
|
|
|
- id: guardrail-2
|
|
|
|
|
severity: blocking
|
|
|
|
|
text: Use synthetic or explicitly approved data only.
|
|
|
|
|
- id: guardrail-3
|
|
|
|
|
severity: blocking
|
|
|
|
|
text: Record every manual prerequisite needed to complete the setup.
|
|
|
|
|
workflow:
|
|
|
|
|
- id: prepare-clean
|
|
|
|
|
title: Prepare clean environment
|
|
|
|
|
instruction: Use a fresh clone and isolated runtime with only documented prerequisites.
|
|
|
|
|
required: true
|
|
|
|
|
- id: follow-docs
|
|
|
|
|
title: Follow documented setup
|
|
|
|
|
instruction: Execute setup exactly as a new operator would and record deviations.
|
|
|
|
|
required: true
|
|
|
|
|
- id: configure-safely
|
|
|
|
|
title: Configure safe values
|
|
|
|
|
instruction: Use generated test secrets and non-production endpoints.
|
|
|
|
|
required: true
|
|
|
|
|
- id: migrate
|
|
|
|
|
title: Initialize data
|
|
|
|
|
instruction: Apply migrations or initialization steps to an empty store.
|
|
|
|
|
required: true
|
|
|
|
|
- id: build-start
|
|
|
|
|
title: Build and start
|
|
|
|
|
instruction: Produce the release build or containers and verify health.
|
|
|
|
|
required: true
|
|
|
|
|
- id: smoke
|
|
|
|
|
title: Run smoke flow
|
|
|
|
|
instruction: Complete the selected critical flow and inspect logs for hidden failures.
|
|
|
|
|
required: true
|
|
|
|
|
- id: restart
|
|
|
|
|
title: Verify persistence
|
|
|
|
|
instruction: Restart services and confirm required state and artifacts persist.
|
|
|
|
|
required: true
|
|
|
|
|
- id: report
|
|
|
|
|
title: Report gaps
|
|
|
|
|
instruction: Update documentation or list exact blockers and environmental assumptions.
|
|
|
|
|
required: true
|
|
|
|
|
validation:
|
|
|
|
|
commandRoles:
|
|
|
|
|
- install
|
|
|
|
|
- migration-status
|
|
|
|
|
- migration-apply
|
|
|
|
|
- build
|
|
|
|
|
- smoke-test
|
|
|
|
|
checks:
|
|
|
|
|
- id: check-1
|
|
|
|
|
type: assertion
|
|
|
|
|
description: A fresh environment reaches the documented smoke flow without private knowledge.
|
|
|
|
|
blocking: true
|
|
|
|
|
evidence: Referenced files, command results or explicit review notes.
|
|
|
|
|
- id: check-2
|
|
|
|
|
type: assertion
|
|
|
|
|
description: All undocumented prerequisites and deviations are reported.
|
|
|
|
|
blocking: true
|
|
|
|
|
evidence: Referenced files, command results or explicit review notes.
|
|
|
|
|
- id: command-install
|
|
|
|
|
type: command
|
|
|
|
|
description: Run the resolved install command when the repository profile provides it and record the result.
|
|
|
|
|
blocking: true
|
|
|
|
|
evidence: Resolved command, exit status and concise result summary.
|
|
|
|
|
- id: command-migration-status
|
|
|
|
|
type: command
|
|
|
|
|
description: Run the resolved migration-status command when the repository profile provides it and record the result.
|
|
|
|
|
blocking: true
|
|
|
|
|
evidence: Resolved command, exit status and concise result summary.
|
|
|
|
|
- id: command-migration-apply
|
|
|
|
|
type: command
|
|
|
|
|
description: Run the resolved migration-apply command when the repository profile provides it and record the result.
|
|
|
|
|
blocking: true
|
|
|
|
|
evidence: Resolved command, exit status and concise result summary.
|
|
|
|
|
- id: command-build
|
|
|
|
|
type: command
|
|
|
|
|
description: Run the resolved build command when the repository profile provides it and record the result.
|
|
|
|
|
blocking: true
|
|
|
|
|
evidence: Resolved command, exit status and concise result summary.
|
|
|
|
|
- id: command-smoke-test
|
|
|
|
|
type: command
|
|
|
|
|
description: Run the resolved smoke-test command when the repository profile provides it and record the result.
|
|
|
|
|
blocking: true
|
|
|
|
|
evidence: Resolved command, exit status and concise result summary.
|
|
|
|
|
completion:
|
|
|
|
|
criteria:
|
|
|
|
|
- Fresh setup succeeds from documented inputs.
|
|
|
|
|
- Missing implicit dependencies are corrected or reported.
|
|
|
|
|
- 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: true
|
|
|
|
|
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:
|
|
|
|
|
- clean-room-validation.static-structure
|
DevRunbook release export