Skip to content

Docs: tighten workflow authoring guidance for noop behavior, workflow_run triage, and scoping#39583

Merged
pelikhan merged 3 commits into
mainfrom
copilot/agent-persona-exploration-2026-06-15
Jun 16, 2026
Merged

Docs: tighten workflow authoring guidance for noop behavior, workflow_run triage, and scoping#39583
pelikhan merged 3 commits into
mainfrom
copilot/agent-persona-exploration-2026-06-15

Conversation

Copilot AI commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Persona exploration found strong trigger/tool/security mapping, but repeated gaps in generated workflow specificity: unclear scope boundaries and inconsistent explicit no-op behavior.

  • Expanded per-automation noop guidance

    • Updated scenario examples in .github/aw/create-agentic-workflow.md to require explicit noop outcomes for:
      • PR visual checks with no relevant file changes
      • deployment/CI triage with duplicate or self-healed failures
      • scheduled digests with no updates in-window
  • Added compact workflow_run triage examples

    • Extended .github/aw/workflow-patterns.md with concise, copyable patterns for:
      • deploy failure triage
      • CI regression watching (including known-flake noop path)
  • Added generated-workflow scoping checklist

    • Introduced a short checklist in .github/aw/create-agentic-workflow.md covering:
      • paths / paths-ignore
      • label scope
      • explicit workflow_run target workflow names/conclusions
      • explicit date windows
      • safe-output write contract vs noop
# Example guidance pattern now reinforced in docs:
on:
  workflow_run:
    workflows: ["CI"]
    types: [completed]

safe-outputs:
  create-issue:

# Prompt contract:
# - create issue only for new actionable regressions
# - call noop for known flakes / self-healed reruns

Copilot AI and others added 2 commits June 16, 2026 16:02
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Explore agent persona findings and address gaps Docs: tighten workflow authoring guidance for noop behavior, workflow_run triage, and scoping Jun 16, 2026
Copilot AI requested a review from pelikhan June 16, 2026 16:10
@pelikhan pelikhan marked this pull request as ready for review June 16, 2026 16:27
Copilot AI review requested due to automatic review settings June 16, 2026 16:27
@pelikhan pelikhan merged commit 510eb69 into main Jun 16, 2026
@pelikhan pelikhan deleted the copilot/agent-persona-exploration-2026-06-15 branch June 16, 2026 16:27

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 tightens the internal authoring docs for gh-aw workflows, focusing on making no-op behavior explicit and improving trigger/scoping guidance—especially for workflow_run-based triage patterns.

Changes:

  • Expanded scenario guidance in .github/aw/create-agentic-workflow.md to require explicit noop outcomes and added a scoping checklist.
  • Added compact workflow_run triage examples in .github/aw/workflow-patterns.md.
  • Updated the generated metadata hash in .github/workflows/objective-impact-report.lock.yml (appears unrelated to the docs changes).
Show a summary per file
File Description
.github/workflows/objective-impact-report.lock.yml Metadata-only change to a generated lock file (likely unintended for a docs-focused PR).
.github/aw/workflow-patterns.md Adds brief workflow_run triage examples for deploy/CI monitoring.
.github/aw/create-agentic-workflow.md Clarifies explicit noop expectations and adds a scoping checklist for generated workflows.

Copilot's findings

Tip

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

  • Files reviewed: 3/3 changed files
  • Comments generated: 3

@@ -1,4 +1,4 @@
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"e357ecaf2b1bac669b156ce98fc34afb31faf80acf85b19f4b1cd9069ab7aca6","body_hash":"24d3f0499ec3d16953e9b5b48edfdc9b9887e87b9de4c92c2955b04698b04122","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.60"}}
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"e357ecaf2b1bac669b156ce98fc34afb31faf80acf85b19f4b1cd9069ab7aca6","body_hash":"978c9220dcee75830e508fe03ceb61df8818787eac3aa9325c1624699a03a99c","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.60"}}
Comment on lines +274 to +275
- [ ] **Workflow-name scope**: for `workflow_run`, explicitly name target workflows and conclusions to avoid accidental matches
- [ ] **Date-window scope**: for reporting/triage, state the exact window (for example `last 24h`, `since previous run`, `current week`)
Comment on lines +42 to +46
Compact `workflow_run` examples:

- **Deploy workflow failure triage**: trigger on `workflow_run` for `Deploy`, read failed jobs/logs/artifacts, create one incident issue, `noop` when rerun succeeds.
- **CI regression watcher**: trigger on `workflow_run` for `CI`, compare current failure against recent runs, create issue only for new regressions, `noop` for known flakes.

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.

3 participants