Document PR ruleset patterns for enforcing agentic workflows - #49975
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
Update governance docs for PR ruleset-based workflow injection
Document PR ruleset patterns for enforcing agentic workflows
Aug 3, 2026
Copilot created this pull request from a session on behalf of
pelikhan
August 3, 2026 12:18
View session
pelikhan
approved these changes
Aug 3, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Documents ruleset-safe patterns for enforcing agentic PR workflows.
Changes:
- Adds governance guidance for required workflows and checks.
- Updates reviewer and repository authoring guidance.
- Registers token observability guidance with the workflow skill.
Show a summary per file
| File | Description |
|---|---|
docs/src/content/docs/guides/governance.md |
Adds ruleset rollout recommendations. |
.github/aw/pr-reviewer.md |
Adds ruleset compatibility guidance. |
.github/aw/instructions.md |
Adds ruleset-safe authoring defaults. |
.github/skills/agentic-workflows/SKILL.md |
Registers observability guidance. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 4/4 changed files
- Comments generated: 4
- Review effort level: Balanced
Comment on lines
+182
to
+183
| 3. Trigger reviewer workflows on PR lifecycle events that matter to rulesets | ||
| (`opened`, `synchronize`, `reopened`, and optionally `ready_for_review`). |
| - Standard frontmatter defaults | ||
| - Frontmatter ordering/style conventions | ||
| - Security or policy constraints specific to this repository | ||
| - For workflows that will be enforced by repository or organization pull request rulesets, keep workflow/job names stable for required checks and use `inlined-imports: true` when imports are present |
Comment on lines
+66
to
+67
| - Keep workflow and job names stable so required-check rulesets keep matching after updates. | ||
| - If imports are used, set `inlined-imports: true` to avoid runtime import failures in ruleset execution contexts. |
Comment on lines
+178
to
+181
| 1. Keep the workflow `name:` and reviewer job names stable so required checks do not | ||
| drift between updates. | ||
| 2. If the workflow uses imports, set `inlined-imports: true` so required-check runs | ||
| do not fail with runtime import resolution errors in ruleset contexts. |
Contributor
|
🎉 This pull request is included in a new release. Release: |
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.
This updates governance and authoring guidance to make PR ruleset adoption predictable when injecting agentic workflow checks across repositories. It also aligns PR reviewer guidance with ruleset constraints to reduce drift and runtime failures.
Governance: ruleset rollout for agentic checks
guides/governance.mdon using org/repo rulesets to require agentic workflow checks.Repository overlay instructions: ruleset-safe authoring defaults
.github/aw/instructions.mdwith explicit guidance for workflows intended for ruleset enforcement:inlined-imports: truewhen imports are presentPR reviewer guidance: ruleset compatibility
.github/aw/pr-reviewer.mdto call out ruleset-compatible trigger coverage (opened,synchronize,reopened, optionallyready_for_review).