Docs: tighten workflow authoring guidance for noop behavior, workflow_run triage, and scoping#39583
Merged
Merged
Conversation
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
Contributor
There was a problem hiding this comment.
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.mdto require explicitnoopoutcomes and added a scoping checklist. - Added compact
workflow_runtriage 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. | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
noopguidance.github/aw/create-agentic-workflow.mdto require explicitnoopoutcomes for:Added compact
workflow_runtriage examples.github/aw/workflow-patterns.mdwith concise, copyable patterns for:nooppath)Added generated-workflow scoping checklist
.github/aw/create-agentic-workflow.mdcovering:paths/paths-ignoreworkflow_runtarget workflow names/conclusionsnoop