Skip to content

[plan] Improve agentic workflow documentation for workflow_run triggers, external APIs, and Playwright network config #25425

@github-actions

Description

@github-actions

Objective

Address documentation gaps identified in the Agent Persona Explorer analysis (2026-04-09) that caused lower quality scores for DevOps, infrastructure, and visual regression workflow scenarios.

Context

The agent persona analysis (overall score 4.1/5) found three documentation gaps that cause the Copilot coding agent to generate suboptimal or incomplete workflows:

  1. workflow_run trigger (gap): Agent defaults to schedule polling instead of reactive workflow_run: [failed] for incident creation — adding latency and wasting compute.
  2. External data integration (gap): No documented pattern for fetching from external APIs (AWS Cost Explorer, GCP Billing, monitoring systems) — agent produces incomplete workflows missing the data ingestion step.
  3. Playwright + network config pairing (gap): The network: { allowed: [defaults, playwright] } combination is not prominently shown — missing it causes silent failures in visual regression workflows.

Tasks

1. Add workflow_run trigger examples to .github/aw/github-agentic-workflows.md

Add a section or example covering:

  • on: workflow_run: workflows: [Deploy] types: [completed] pattern
  • How to filter for failures using github.event.workflow_run.conclusion == 'failure'
  • A concrete DevOps incident-response example (e.g., create an issue when a deploy workflow fails)

2. Add external data integration guidance to .github/aw/create-agentic-workflow.md

Add a section documenting:

  • Using the web-fetch tool for external HTTP APIs (cost tools, monitoring systems)
  • Configuring network.allowed with placeholder domains (e.g., cost.us-east-1.amazonaws.com)
  • A short example snippet showing the frontmatter + prompt pattern for fetching external metrics

3. Expand Playwright network configuration examples in .github/aw/github-agentic-workflows.md

Update the Playwright section to:

  • Prominently show network: { allowed: [defaults, playwright] } as the required pairing
  • Explain that omitting defaults or playwright blocks browser automation network access
  • Add a minimal visual regression workflow example that uses this configuration

Files to Modify

  • .github/aw/github-agentic-workflows.mdworkflow_run trigger section + Playwright network pairing
  • .github/aw/create-agentic-workflow.md — External data integration guidance

Acceptance Criteria

  • .github/aw/github-agentic-workflows.md contains a workflow_run trigger example for failure-reactive workflows
  • .github/aw/create-agentic-workflow.md documents web-fetch + network.allowed for external API access
  • .github/aw/github-agentic-workflows.md Playwright section shows network: { allowed: [defaults, playwright] } prominently
  • All examples are syntactically valid YAML/Markdown
  • No existing documentation is broken or removed

Source

Discussion: #25422

Generated by Plan Command for issue #discussion #25422 · ● 130.2K ·

  • expires on Apr 11, 2026, 4:39 AM UTC

Metadata

Metadata

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions