Publish DevRunbook source

content/playbooks/gitignore-hygiene/playbook.yaml

@@ -0,0 +1,205 @@
+apiVersion: devrunbook.io/v1alpha1
+kind: Playbook
+metadata:
+  id: git-gitea.gitignore-hygiene
+  slug: gitignore-hygiene
+  version: 1.0.0
+  title: Audit and Repair .gitignore Hygiene
+  summary: Identify tracked runtime/generated files and improve ignore rules without hiding required source or configuration
+    examples.
+  category: git-gitea
+  tags:
+  - gitignore
+  - cleanup
+  - repository
+  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 audit and repair .gitignore hygiene is often underspecified, inconsistently executed
+      or reported without enough evidence.
+    outcome: Identify tracked runtime/generated files and improve ignore rules without hiding required source or configuration
+      examples.
+    whenToUse:
+    - Use this playbook when the repository needs a bounded audit and repair .gitignore hygiene 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: runtimePaths
+    label: Runtime paths
+    description: List paths that contain local data, generated output, caches or deployment state.
+    type: string-list
+    required: false
+    sensitive: false
+    includeInOutput: true
+    default: []
+  - key: requiredExamples
+    label: Required tracked examples
+    description: List example configuration files that must remain tracked despite nearby ignore rules.
+    type: string-list
+    required: false
+    sensitive: false
+    includeInOutput: true
+    default: []
+  compatibility:
+    repositoryRequired: true
+    languages: []
+    frameworks: []
+    packageManagers: []
+    databases: []
+    deploymentTypes: []
+    requiredProfileCapabilities: []
+    incompatibleConditions: []
+  guardrails:
+  - id: guardrail-1
+    severity: blocking
+    text: Never delete ignored local data merely because it should not be tracked.
+  - id: guardrail-2
+    severity: blocking
+    text: Preserve required example configuration and fixture files.
+  - id: guardrail-3
+    severity: blocking
+    text: Prove a path is generated, local or sensitive before adding a broad ignore rule.
+  workflow:
+  - id: inventory-rules
+    title: Inventory ignore rules
+    instruction: Inspect root and nested ignore files, tracked generated files and deployment-specific runtime paths.
+    required: true
+  - id: classify-paths
+    title: Classify paths
+    instruction: Separate source, required examples, generated output, caches, local data, secrets and artifacts.
+    required: true
+  - id: detect-conflicts
+    title: Detect conflicts
+    instruction: Find overly broad patterns, negation conflicts, platform gaps and already tracked files.
+    required: true
+  - id: update-rules
+    title: Update rules
+    instruction: Apply the smallest clear ignore patterns and explanatory comments where needed.
+    required: true
+  - id: handle-tracked
+    title: Handle tracked files safely
+    instruction: Recommend or perform index-only removal when authorized; never delete the local data.
+    required: true
+  - id: verify
+    title: Verify behavior
+    instruction: Use Git ignore diagnostics and run relevant build/tests to ensure required files remain available.
+    required: true
+  validation:
+    commandRoles:
+    - build
+    - unit-test
+    checks:
+    - id: check-1
+      type: assertion
+      description: Representative runtime paths are ignored and required examples remain tracked.
+      blocking: true
+      evidence: Referenced files, command results or explicit review notes.
+    - id: check-2
+      type: assertion
+      description: No local data is deleted and tracked-file changes are explicit.
+      blocking: true
+      evidence: Referenced files, command results or explicit review notes.
+    - 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-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.
+  completion:
+    criteria:
+    - Ignore rules match actual generated/runtime behavior.
+    - Required source and example configuration remain tracked.
+    - 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:
+  - gitignore-hygiene.static-structure