-
Notifications
You must be signed in to change notification settings - Fork 296
Closed
Labels
ai-generatedai-inspecteddocumentationImprovements or additions to documentationImprovements or additions to documentationplan
Description
Objective
Create a runbook documenting how to investigate and resolve workflow health issues, based on learnings from the DeepReport incident response.
Context
The DeepReport identified several workflow issues (failures, missing-tool errors) that needed investigation. A documented runbook will help future agents and maintainers quickly diagnose and fix similar problems.
Approach
- Create a new documentation file (e.g.,
docs/runbooks/workflow-health.md) - Document common workflow failure patterns:
- Missing tool configurations
- Authentication/permission errors
- Input/secret validation failures
- Add investigation steps:
- How to analyze workflow logs
- How to identify missing-tool errors
- How to verify MCP server configurations
- Include resolution procedures:
- Adding GitHub MCP server to workflows
- Configuring safe-inputs/safe-outputs
- Testing workflow fixes
- Link to relevant documentation and examples
Files to Create
docs/runbooks/workflow-health.md(or similar location)
Acceptance Criteria
- Runbook covers common workflow failure types
- Investigation steps are clear and actionable
- Resolution procedures include code examples
- Document references the DeepReport findings as case study
- Runbook is linked from main documentation
- Format follows repository documentation standards (Diátaxis framework)
Related to [plan] Address workflow health and issue triage findings from DeepReport 2025-12-22 #7280
AI generated by Plan Command for discussion #7277
Reactions are currently unavailable
Metadata
Metadata
Labels
ai-generatedai-inspecteddocumentationImprovements or additions to documentationImprovements or additions to documentationplan