Skip to content

[plan] Create workflow template library for 7 high-value automation patterns #10290

@github-actions

Description

@github-actions

Objective

Create a library of 7 reusable workflow templates based on high-performing patterns identified in research, making it easier for users to start with proven automation patterns.

Context

Research identified 7 distinct workflow categories with excellent performance. Formalizing these as templates will help users quickly implement common automation patterns without starting from scratch.

Templates to Create

  1. PR Code Review Automation - Analyze code changes → Post PR comment (BE-1, FE-2, FE-3, QA-1)
  2. Scheduled Monitoring with Alerting - Query API/data → Detect issues → Create GitHub issue (BE-2, DO-1, DO-2, QA-2)
  3. Visual Testing Automation - Playwright + artifact uploads + PR comments (FE-1)
  4. On-Demand Report Generation - Aggregate data → Format → Post discussion (PM-1, PM-2)
  5. Multi-Phase Analysis Pipelines - Data collection → Analysis → Historical tracking → Reporting (QA-2)
  6. Rate-Limited Automation - Detect items → Prioritize → Create limited PRs/issues (DO-2)
  7. API Integration with Persistence - External API → Compare to baseline (repo-memory) → Alert (BE-2)

Approach

  1. Create template directory: .github/workflows/templates/

  2. Extract patterns from high-scoring scenarios:

    • Visual regression testing (5.0) → Template 3
    • Flaky test tracking (5.0) → Template 5
    • Security scanner (5.0) → Template 6
    • API performance monitoring (5.0) → Template 7
  3. Each template includes:

    • Markdown workflow file with placeholders
    • Configuration checklist
    • Common variations
    • Usage examples
    • Link to source scenario from research
  4. Update agent instructions to reference templates when appropriate

Files to Create

  • Create: .github/workflows/templates/pr-code-review.md
  • Create: .github/workflows/templates/scheduled-monitoring.md
  • Create: .github/workflows/templates/visual-testing.md
  • Create: .github/workflows/templates/on-demand-report.md
  • Create: .github/workflows/templates/multi-phase-analysis.md
  • Create: .github/workflows/templates/rate-limited-automation.md
  • Create: .github/workflows/templates/api-persistence.md
  • Create: .github/workflows/templates/README.md (template catalog)
  • Update: .github/instructions/developer.instructions.md (reference templates)

Acceptance Criteria

  • All 7 templates created with working placeholder workflows
  • Each template has clear configuration checklist
  • Templates include 2-3 common variations
  • Template catalog README documents when to use each template
  • Agent instructions reference templates for matching scenarios
  • At least 3 templates tested by compiling and running

Expected Impact

Reduces time-to-first-workflow from 25 minutes to under 5 minutes for common patterns, leveraging proven high-quality examples from research.
Related to #10285

AI generated by Plan Command for discussion #10248

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions