This commit is contained in:
DevRunbook release export
@@ -0,0 +1,218 @@
|
||||
apiVersion: devrunbook.io/v1alpha1
|
||||
kind: Playbook
|
||||
metadata:
|
||||
id: bugfixing.build-failure-recovery
|
||||
slug: build-failure-recovery
|
||||
version: 1.0.0
|
||||
title: Build Failure Recovery
|
||||
summary: Diagnose and repair a failing build while preserving intended build checks and avoiding broad dependency churn.
|
||||
category: bugfixing
|
||||
tags:
|
||||
- build
|
||||
- ci
|
||||
- recovery
|
||||
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: guided
|
||||
intent:
|
||||
problem: Development work around build failure recovery is often underspecified, inconsistently executed or reported without
|
||||
enough evidence.
|
||||
outcome: Diagnose and repair a failing build while preserving intended build checks and avoiding broad dependency churn.
|
||||
whenToUse:
|
||||
- Use this playbook when the repository needs a bounded build failure recovery 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:
|
||||
- recovery
|
||||
- execute
|
||||
defaultMode: recovery
|
||||
autonomy:
|
||||
min: diagnose
|
||||
max: repair
|
||||
default: verify
|
||||
inputs:
|
||||
- key: buildCommand
|
||||
label: Build command
|
||||
description: Provide the exact failing build command when it is not already in the repository profile.
|
||||
type: command
|
||||
required: false
|
||||
sensitive: false
|
||||
includeInOutput: true
|
||||
default: ''
|
||||
- key: failureOutput
|
||||
label: Failure output
|
||||
description: Provide the relevant build output with secrets and private data removed.
|
||||
type: multiline
|
||||
required: true
|
||||
sensitive: false
|
||||
includeInOutput: true
|
||||
compatibility:
|
||||
repositoryRequired: true
|
||||
languages: []
|
||||
frameworks: []
|
||||
packageManagers: []
|
||||
databases: []
|
||||
deploymentTypes: []
|
||||
requiredProfileCapabilities:
|
||||
- build-command
|
||||
incompatibleConditions: []
|
||||
guardrails:
|
||||
- id: guardrail-1
|
||||
severity: blocking
|
||||
text: Do not delete lockfiles, tests or type checks merely to obtain a successful build.
|
||||
- id: guardrail-2
|
||||
severity: blocking
|
||||
text: Do not perform broad dependency upgrades before identifying the first causal failure.
|
||||
- id: guardrail-3
|
||||
severity: blocking
|
||||
text: Preserve the original failure evidence and distinguish pre-existing warnings from new regressions.
|
||||
workflow:
|
||||
- id: capture-baseline
|
||||
title: Capture failure baseline
|
||||
instruction: Run the failing command or the repository build role and preserve the first actionable failure.
|
||||
required: true
|
||||
- id: classify
|
||||
title: Classify the failure
|
||||
instruction: Determine whether the cause is source, configuration, generated assets, dependencies, environment or tooling.
|
||||
required: true
|
||||
- id: minimize
|
||||
title: Minimize reproduction
|
||||
instruction: Reduce the failure to the narrowest package, target or step without changing its cause.
|
||||
required: true
|
||||
- id: repair
|
||||
title: Apply causal repair
|
||||
instruction: Implement the smallest maintainable fix and explain why it addresses the cause.
|
||||
required: true
|
||||
- id: targeted-build
|
||||
title: Run targeted build
|
||||
instruction: Re-run the narrow target first and repair directly caused failures.
|
||||
required: true
|
||||
- id: full-build
|
||||
title: Run full validation
|
||||
instruction: Run the repository build and relevant tests, lint and typecheck.
|
||||
required: true
|
||||
- id: review
|
||||
title: Review final state
|
||||
instruction: Confirm lockfiles, generated files and configuration changed only when necessary.
|
||||
required: true
|
||||
validation:
|
||||
commandRoles:
|
||||
- lint
|
||||
- typecheck
|
||||
- unit-test
|
||||
- build
|
||||
checks:
|
||||
- id: check-1
|
||||
type: assertion
|
||||
description: The first causal build failure is identified with evidence.
|
||||
blocking: true
|
||||
evidence: Referenced files, command results or explicit review notes.
|
||||
- id: check-2
|
||||
type: assertion
|
||||
description: The original build command and relevant quality gates pass after the repair.
|
||||
blocking: true
|
||||
evidence: Referenced files, command results or explicit review notes.
|
||||
- id: command-lint
|
||||
type: command
|
||||
description: Run the resolved lint command when the repository profile provides it and record the result.
|
||||
blocking: true
|
||||
evidence: Resolved command, exit status and concise result summary.
|
||||
- id: command-typecheck
|
||||
type: command
|
||||
description: Run the resolved typecheck command when the repository profile provides it and record the result.
|
||||
blocking: true
|
||||
evidence: Resolved command, exit status and concise result summary.
|
||||
- id: command-unit-test
|
||||
type: command
|
||||
description: Run the resolved unit-test 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.
|
||||
completion:
|
||||
criteria:
|
||||
- Root cause is identified.
|
||||
- The original build command succeeds without disabled checks.
|
||||
- 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:
|
||||
- build-failure-recovery.static-structure
|
||||
Reference in New Issue
Block a user