Skip to content

docs: clarify safe-output tool names, add incident dedup patterns, expand visual-regression guidance#40127

Closed
Copilot wants to merge 5 commits into
mainfrom
copilot/agent-persona-exploration-again
Closed

docs: clarify safe-output tool names, add incident dedup patterns, expand visual-regression guidance#40127
Copilot wants to merge 5 commits into
mainfrom
copilot/agent-persona-exploration-again

Conversation

Copilot AI commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Agent persona testing surfaced three gaps in the agentic workflow reference docs: ambiguous safe-output tool/import naming, missing duplicate-detection guidance for incident workflows, and thin lifecycle guidance for visual regression baselines.

safe-outputs-content.md — naming convention + comment-vs-issue decision table

  • Added a Tool Naming Convention table mapping every YAML config key (kebab-case) to its MCP tool name (snake_case) — e.g. add-comment:add_comment, create-issue:create_issue. Custom jobs:/actions: entries follow the same rule.
  • Added a Comment vs Issue Pattern table covering four common scenarios so agents reliably pick the right output type (inline PR finding → add-comment; incident/report needing follow-up → create-issue; rolling status → add-comment + hide-older-comments: true; recurring digest → group-by-day: true).

create-agentic-workflow.md — incident workflow duplicate detection (new §2a)

Three concrete patterns for deployment_status/workflow_run triggered incident workflows:

# Title-based (zero agent-token cost guardrail)
safe-outputs:
  create-issue:
    title-prefix: "[incident] "
    deduplicate-by-title: true   # case-insensitive full-title match; integer N = fuzzy edit-distance
    expires: 3

# Rolling tracker (closes previous open issue before creating new one)
safe-outputs:
  create-issue:
    title-prefix: "[incident] "
    close-older-issues: true
    expires: 7

Also documents the prompt-side pattern (agent queries for open issues before calling create_issue) and guidance on when to combine approaches for defense-in-depth on high-volume triggers.

visual-regression.md — baseline storage, update workflow, artifact retention

  • Added a Baseline Storage section with manifest structure and a companion workflow_dispatch workflow for updating baselines after intentional UI changes.
  • Added an Artifact Retention section: upload-artifact (run-scoped, retention-days: 14) for downloadable diff archives; upload-asset for stable embeddable URLs when diff images need to appear inline in comments.
  • Updated the example workflow to include upload-artifact for diff screenshots alongside add-comment.

Copilot AI and others added 2 commits June 18, 2026 18:39
…pand visual-regression guidance

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
…p guidance

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Update findings from agent persona exploration docs: clarify safe-output tool names, add incident dedup patterns, expand visual-regression guidance Jun 18, 2026
Copilot AI requested a review from pelikhan June 18, 2026 18:42
Comment thread .github/aw/visual-regression.md Outdated
max-uploads: 5
retention-days: 14 # keep diffs for 2 weeks (range: 1-90)
allowed-paths:
- "/tmp/visual-regression/**"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@copilot allowed paths are relative to the repo workspace root

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed in 9a8706e — changed allowed-paths to visual-regression-diffs/** (workspace-relative) in both the example workflow and the Artifact Retention section, and updated the prompt to instruct the agent to copy diffs there before uploading.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI requested a review from pelikhan June 19, 2026 00:36
@pelikhan

Copy link
Copy Markdown
Collaborator

@copilot review changes and unbloat, keep high importance information

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI commented Jun 19, 2026

Copy link
Copy Markdown
Contributor Author

@copilot review changes and unbloat, keep high importance information

Done in the latest commit. Trimmed:

  • safe-outputs-content.md: removed the two "Prefer X when:" paragraphs that duplicated the table
  • create-agentic-workflow.md: collapsed the verbose prompt snippet + numbered list into a single sentence
  • visual-regression.md: removed the manifest JSON schema, replaced the full second-workflow YAML with a compact note, and removed the standalone Artifact Retention YAML block (already shown in the example)

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants