Skip to content

docs: add workflow_run triggers, external API integration, and Playwright network config guidance#25433

Closed
Copilot wants to merge 3 commits intomainfrom
copilot/improve-workflow-documentation
Closed

docs: add workflow_run triggers, external API integration, and Playwright network config guidance#25433
Copilot wants to merge 3 commits intomainfrom
copilot/improve-workflow-documentation

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 9, 2026

Three documentation gaps in .github/aw/ caused the Copilot agent to generate suboptimal workflows for DevOps, infrastructure, and visual regression scenarios (identified via agent persona analysis, overall score 4.1/5).

workflow_run trigger pattern — .github/aw/github-agentic-workflows.md

New ### workflow_run Trigger: Failure-Reactive Workflows section under Trigger Patterns:

  • Reactive workflow_run: [completed] + if: conclusion == 'failure' replaces schedule polling for incident response
  • Concrete DevOps example: create a deduplicated incident issue when a Deploy workflow fails
  • Comparison table: workflow_run (GitHub Actions pipelines) vs deployment_status (external deployment services)

Playwright network config — .github/aw/github-agentic-workflows.md

New ### Playwright Network Configuration section after the ecosystem identifier table:

  • Both defaults and playwright are required — omitting either causes silent failures (cert validation vs browser binary downloads)
  • Minimal visual regression workflow example with the correct pairing:
network:
  allowed:
    - defaults    # certificates, Ubuntu mirrors
    - playwright  # browser binary CDN

External data integration — .github/aw/create-agentic-workflow.md

New ### External Data Integration section after Pre-step Data Fetching:

  • web-fetch + network.allowed pattern for external HTTP APIs (AWS Cost Explorer, Datadog, etc.)
  • Frontmatter template with placeholder domains, prompt pattern, and secrets injection syntax clarified ($AWS_API_KEY in prompt body vs ${{ secrets.AWS_API_KEY }} in steps: blocks)

…work documentation

- Add workflow_run trigger failure-reactive pattern section with DevOps incident-response example
- Add Playwright network configuration section showing defaults+playwright pairing requirement
- Add external data integration section with web-fetch + network.allowed guidance, secrets clarification

Agent-Logs-Url: https://github.com/github/gh-aw/sessions/cc2c31b8-df29-4dc6-a591-431fa31ecafe

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation for workflow_run triggers and external APIs docs: add workflow_run triggers, external API integration, and Playwright network config guidance Apr 9, 2026
Copilot AI requested a review from pelikhan April 9, 2026 05:35
@github-actions github-actions bot mentioned this pull request Apr 9, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 9, 2026

Hey @Copilot 👋 — great effort documenting three real pain-points in the agentic workflow authoring guide! The workflow_run incident-response pattern, the Playwright defaults+playwright pairing requirement, and the external API integration template are all genuinely useful additions.

A few things that would help get this across the finish line:

  • Split into focused PRs — this bundles three independent documentation improvements into a single PR: (1) workflow_run failure-reactive triggers, (2) Playwright network configuration, and (3) external data integration via web-fetch. Each topic is self-contained and could be reviewed, merged, or rolled back independently. Splitting them makes review easier and keeps the git history navigable.
  • Draft status — the PR is currently in draft. Once the above is addressed (or if bundling is intentional), marking it ready-for-review will unblock the maintainer review from @pelikhan.
  • No test signal — documentation-only changes don't require test files, but if any of the YAML/Markdown examples are machine-validated (e.g. via schema linting or workflow rendering tests), it's worth confirming the new frontmatter examples pass those checks.

If you'd like a hand splitting and polishing these docs, you can assign this prompt to your coding agent:

Split PR #25433 into three separate pull requests, each targeting the `main` branch of `github/gh-aw`:

1. **PR 1 — workflow_run triggers**
   - Add only the `### workflow_run Trigger: Failure-Reactive Workflows` section to `.github/aw/github-agentic-workflows.md`
   - Branch name: `copilot/docs-workflow-run-trigger`
   - PR title: `docs: add workflow_run failure-reactive trigger pattern`

2. **PR 2 — Playwright network configuration**
   - Add only the `### Playwright Network Configuration` section to `.github/aw/github-agentic-workflows.md`
   - Branch name: `copilot/docs-playwright-network`
   - PR title: `docs: document required defaults+playwright network pairing`

3. **PR 3 — External data integration**
   - Add only the `### External Data Integration` section to `.github/aw/create-agentic-workflow.md`
   - Branch name: `copilot/docs-external-data-integration`
   - PR title: `docs: add web-fetch external API integration pattern`

For each PR:
- Cherry-pick only the relevant diff lines from branch `copilot/improve-workflow-documentation`
- Write a concise PR body explaining the single documentation gap being addressed
- Mark the PR as ready for review (not draft)
- Request review from `@pelikhan`

Close PR #25433 after all three PRs are open.

Generated by Contribution Check · ● 1.7M ·

@pelikhan
Copy link
Copy Markdown
Collaborator

pelikhan commented Apr 9, 2026

@copilot unbloat update

… redundant examples

Agent-Logs-Url: https://github.com/github/gh-aw/sessions/72748746-cb7d-442c-9bad-7bb9fd499bc2

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 9, 2026

@copilot unbloat update

Done in 9018a4c. Trimmed the three added sections significantly (158 lines → 46 net additions):

  • workflow_run section: removed "When to use" bullets, anti-polling warning, context-expression list (already in the doc), and comparison table — kept pattern snippet + one compact example
  • Playwright section: collapsed to a one-liner rationale + YAML snippet + link to visual-regression.md (which already has the full example)
  • External data integration: merged the separate frontmatter-template and prompt-pattern blocks into a single combined example; folded secrets note inline

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

2 participants