Improve pr-docs-check reliability guidance#17552
Open
IEvangelist wants to merge 1 commit into
Open
Conversation
Add explicit guardrails in the pr-docs-check workflow prompt to reduce deterministic safe-output failures, then recompile workflow artifacts. - Add constraints to keep generated docs patches targeted and under safe-output limits. - Add explicit handling for locked source PRs to avoid hard-failing notify flow. - Regenerate lock artifacts via gh aw compile. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 17552Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 17552" |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR tightens the pr-docs-check agentic workflow prompt with reliability guardrails (limit doc patch size, fall back to report_incomplete on risky changes, and skip notify_source_pr when the source PR is locked) and recompiles the lock files. The compiled .lock.yml was regenerated with gh-aw v0.74.8, bringing along upstream toolchain bumps (firewall 0.25.49, mcpg v0.3.9, github-mcp-server v1.0.4, copilot CLI 1.0.48, model default claude-sonnet-4.5).
Changes:
- Add "Reliability guardrails for generated doc edits" and "Locked source PR handling" sections to
pr-docs-check.md. - Recompile
pr-docs-check.lock.ymlwith gh-aw v0.74.8 (action/container pins, span-id propagation, DOCKER_HOST handling, token-steering AWF config). - Update
actions-lock.jsonto pingithub/gh-aw-actions/setup@v0.74.8and drop the unusedsetup-clientry.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| .github/workflows/pr-docs-check.md | Adds hard reliability guardrails and locked-PR handling guidance to the workflow prompt. |
| .github/workflows/pr-docs-check.lock.yml | Regenerated by gh aw compile with v0.74.8 toolchain bumps. |
| .github/aw/actions-lock.json | Bumps gh-aw-actions/setup pin to v0.74.8; removes stale setup-cli entry. |
Contributor
|
❌ CLI E2E Tests failed — 106 passed, 1 failed, 2 unknown (commit Failed Tests
View all recordings
📹 Recordings uploaded automatically from CI run #26529541957 |
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.
Description
This improves reliability of the
pr-docs-checkagentic workflow by tightening prompt guidance around known safe-output failure modes, while keeping core workflow mechanics (auth, checkout, and branch-resolution flow) unchanged.Key improvements:
report_incomplete.Validation:
gh aw compile .github/workflows/pr-docs-check.mdcompleted successfully with no errors/warnings.Fixes # (issue)
Checklist
<remarks />and<code />elements on your triple slash comments?