Skip to content

[plan] Document workflow health monitoring runbook #7285

@github-actions

Description

@github-actions

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

  1. Create a new documentation file (e.g., docs/runbooks/workflow-health.md)
  2. Document common workflow failure patterns:
    • Missing tool configurations
    • Authentication/permission errors
    • Input/secret validation failures
  3. Add investigation steps:
    • How to analyze workflow logs
    • How to identify missing-tool errors
    • How to verify MCP server configurations
  4. Include resolution procedures:
    • Adding GitHub MCP server to workflows
    • Configuring safe-inputs/safe-outputs
    • Testing workflow fixes
  5. Link to relevant documentation and examples

Files to Create

  • docs/runbooks/workflow-health.md (or similar location)

Acceptance Criteria

AI generated by Plan Command for discussion #7277

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions