Uh oh!
There was an error while loading. Please reload this page.
docs: add db migration pattern, deployment_status clarification, and PR-report checklist - #37904
Merged
Merged
Conversation
- Add deployment_status row to decision matrix and workflow_run vs deployment_status clarification in create-agentic-workflow.md - Add compact PR-report checklist to create-agentic-workflow.md - Add Database Migration Safety Pattern to workflow-patterns.md Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
CopilotAI
changed the title
[WIP] Explore agent persona and workflow patternsdocs: add db migration pattern, deployment_status clarification, and PR-report checklistJun 8, 2026
pelikhan
reviewed
Jun 8, 2026
| - permissions: `contents: read`, `pull-requests: read`; keep agent job read-only | ||
| - reads: changed migration file content via GitHub tools | ||
| - output: `add-comment` with a safety summary flagging risky operations; use `noop` when no concerns are detected | ||
| - safety checks to include in the agent prompt: |
Collaborator
There was a problem hiding this comment.
@copilot remove section on safety check and replace "suggest migration best practices in the agent prompt"
ContributorAuthor
There was a problem hiding this comment.
Done in 9e0b33d — replaced the detailed safety-checks sub-list with - prompt: suggest migration best practices in the agent prompt.
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the gh-aw authoring docs to close three documentation gaps: safe patterns for database migration review workflows, clearer trigger selection between workflow_run and deployment_status for incident automation, and a compact checklist for PR-triggered reporting workflows.
Changes:
- Added a “Database Migration Safety Pattern” to the shared workflow patterns reference.
- Expanded the trigger decision matrix with
deployment_statusand added a clarifying note comparing it toworkflow_run. - Added a compact “PR-Report Checklist” to help validate key PR-report workflow design decisions.
Show a summary per file
| File | Description |
|---|---|
| .github/aw/workflow-patterns.md | Adds a database migration review pattern alongside existing workflow design patterns. |
| .github/aw/create-agentic-workflow.md | Clarifies workflow_run vs deployment_status selection and adds a PR-report checklist section. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 2
| For pull requests that add or modify database migration files: | ||
| - trigger: `pull_request` with `paths:` scoped to migration directories (e.g. `db/migrate/**`, `migrations/**`, `*.sql`) |
| - [ ] **Permissions**: `contents: read` + `pull-requests: read` in the agent job; no write permissions | ||
| - [ ] **Safe outputs**: `add-comment` for inline findings; `create-issue` for incidents needing follow-up | ||
| - [ ] **Network**: infer ecosystem from repository lock files; never use `defaults` alone when packages are installed |
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 freeto 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.
Three gaps identified by the agent persona exploration: no database migration guidance, ambiguous
workflow_runvsdeployment_statusselection for incident automation, and no quick-reference checklist for PR-triggered reporting workflows.workflow-patterns.md— Database Migration Safety PatternNew pattern section (consistent with PR Visual Regression style) covering trigger path-scoping, read-only permissions, and a prompt note to suggest migration best practices in the agent prompt.
create-agentic-workflow.md—workflow_runvsdeployment_statusclarificationdeployment_statusrow to the quick decision matrix (deployments: read→create-issue)create-agentic-workflow.md— Compact PR-Report ChecklistNew checklist section after the Recommended Workflow Skeleton covering the four key decisions before finalizing any
pull_request-triggered reporting workflow: minimal permissions, safe-output mapping, network selection, and mandatorynoopfor clean runs.