Skip to content

Tighten workflow authoring guidance for trigger selection, scenario mapping, and visual-regression network scope#39119

Merged
pelikhan merged 3 commits into
mainfrom
copilot/agent-persona-exploration-again
Jun 13, 2026
Merged

Tighten workflow authoring guidance for trigger selection, scenario mapping, and visual-regression network scope#39119
pelikhan merged 3 commits into
mainfrom
copilot/agent-persona-exploration-again

Conversation

Copilot AI commented Jun 13, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Persona exploration showed strong baseline guidance but identified three doc gaps: compact scenario examples in workflow creation, clearer deployment_status vs workflow_run selection, and explicit network-minimization guidance for visual regression workflows. This PR updates those references to make authoring decisions faster and more consistent.

  • Workflow creation guidance (.github/aw/create-agentic-workflow.md)

    • Adds compact scenario mappings for:
      • schema review on PRs
      • visual regression on UI changes
      • deployment incident triage
      • scheduled product/stakeholder digests
    • Emphasizes expected safe-output routing and explicit noop behavior in these scenarios.

  • Monitoring trigger decisioning (.github/aw/workflow-patterns.md)

    • Adds a direct rule-of-thumb split:
      • workflow_run for GitHub Actions outcomes in-repo
      • deployment_status for external deployment providers via Deployments API
    • Documents single-job constraints explicitly for both patterns (no fan-out/fan-in orchestration or cross-workflow waits).

  • Visual regression network posture (.github/aw/visual-regression.md)

    • Adds a dedicated network-minimization section:
      • prefer localhost previews
      • narrowly allowlist only required preview domains
      • enable network.node only when build/install is needed
      • keep Playwright navigation scoped to app-under-test URLs.
Quick rule of thumb:

- `workflow_run` → GitHub Actions workflow/job outcomes in this repository
- `deployment_status` → external platform deployment outcomes reported through the Deployments API

Copilot AI and others added 2 commits June 13, 2026 17:00
@pelikhan
Plan minimal docs updates for issue 39103
6f7c33e 
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
@pelikhan
Update agentic workflow guidance from persona exploration findings
1bb4b99 
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Update agent persona exploration insights Tighten workflow authoring guidance for trigger selection, scenario mapping, and visual-regression network scope Jun 13, 2026
Copilot AI requested a review from pelikhan June 13, 2026 17:10
@pelikhan pelikhan marked this pull request as ready for review June 13, 2026 17:53
Copilot AI review requested due to automatic review settings June 13, 2026 17:53
@pelikhan pelikhan merged commit 6f35f67 into main Jun 13, 2026
@pelikhan pelikhan deleted the copilot/agent-persona-exploration-again branch June 13, 2026 17:54
Copilot AI reviewed Jun 13, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates gh-aw authoring documentation to make trigger selection and common workflow scenarios easier to choose, and adds explicit guidance for minimizing network exposure in visual regression workflows.

Changes:

  • Added a concise workflow_run vs deployment_status rule-of-thumb and reiterated single-job constraints in monitoring patterns.
  • Added compact “scenario example” mappings to the workflow creation guide (schema review, visual regression, deployment triage, stakeholder digest).
  • Added a network-minimization reminder section to the visual regression reference (with additional guardrails for previews and Playwright navigation).
Show a summary per file
File Description
.github/workflows/test-quality-sentinel.lock.yml Updates generated workflow metadata and adjusts safe-output success messaging template.
.github/aw/workflow-patterns.md Adds explicit trigger decision guidance (workflow_run vs deployment_status) plus single-job constraint reminders.
.github/aw/visual-regression.md Adds a “Network-Minimization Reminders” section for safer visual regression workflows.
.github/aw/create-agentic-workflow.md Adds compact scenario examples to speed up initial workflow authoring decisions.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 4/4 changed files
  • Comments generated: 2

Comment thread .github/aw/visual-regression.md

- Prefer local preview serving (`localhost`/`127.0.0.1`) over external preview environments when possible.
- If external previews are required, allowlist only exact preview domains needed for the check (avoid broad wildcards).
- Enable `network.node` only when the workflow actually installs/builds Node dependencies; scope domains to package registries and required preview hosts.
Comment thread .github/workflows/test-quality-sentinel.lock.yml
env:
GH_AW_WORKFLOW_NAME: "Test Quality Sentinel"
GH_AW_SAFE_OUTPUT_MESSAGES: "{\"footer\":\"\\u003e 🧪 *Test quality analysis by [{workflow_name}]({run_url})*{ai_credits_suffix}{history_link}\",\"runStarted\":\"🔬 [{workflow_name}]({run_url}) is analyzing test quality on this {event_type}...\",\"runSuccess\":\"🧪 [{workflow_name}]({run_url}) completed test quality analysis.\",\"runFailure\":\"❌ [{workflow_name}]({run_url}) {status} during test quality analysis.\"}"
GH_AW_SAFE_OUTPUT_MESSAGES: "{\"footer\":\"\\u003e 🧪 *Test quality analysis by [{workflow_name}]({run_url})*{ai_credits_suffix}{history_link}\",\"runStarted\":\"🔬 [{workflow_name}]({run_url}) is analyzing test quality on this {event_type}...\",\"runSuccess\":\"✅ [{workflow_name}]({run_url}) completed test quality analysis.\",\"runFailure\":\"❌ [{workflow_name}]({run_url}) {status} during test quality analysis.\"}"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

+1 more reviewer

@pelikhan pelikhan pelikhan approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@pelikhan pelikhan

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@pelikhan