fix: Docs-check reliable issues, no noise - #249
Conversation
- Remove create-pull-request (token can't push to docs-maui) - Remove add-comment for 'no docs needed' (silent skip instead) - Remove checkout of docs-maui (not needed for issue creation) - Issue body is self-contained with source PR link, summary, affected pages, and suggested ready for an agenticchanges workflow on the docs-maui side to pick up Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
d1977f1 to
07230ca
Compare
There was a problem hiding this comment.
Pull request overview
Updates the pr-docs-check agentic workflow to eliminate cross-repo patch/PR creation and instead file a single, self-contained issue in dotnet/docs-maui only when documentation work is required, otherwise producing no noise.
Changes:
- Switch safe outputs from
create_pull_request/PR commenting tocreate_issuetargetingdotnet/docs-maui. - Remove the secondary
docs-mauicheckout and patch/push handling paths; reduce runtime timeout (20 → 15 minutes). - Adjust workflow/job permissions and outputs wiring to match the issue-only flow and avoid label-related permission failures.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| .github/workflows/pr-docs-check.md | Updates the workflow prompt/instructions to stop silently when no docs are needed and to create a detailed docs-maui issue when they are. |
| .github/workflows/pr-docs-check.lock.yml | Regenerates the compiled workflow to remove PR-creation/comment tooling, checkout/push steps, and to allow only create_issue safe outputs. |
Expert Code Review — PR #249Methodology: 3 independent reviewers with adversarial consensus 2 findings (1 posted inline, 1 in overflow below) — both 🟢 minor. Overflow (line outside diff — cannot post inline)
Discarded findings (did not reach consensus)
CI Status
Test CoverageN/A — this PR modifies only workflow YAML and Markdown (no source code or tests applicable).
|
There was a problem hiding this comment.
Expert Code Review: 2 findings (1 inline, 1 overflow — both minor). See the summary comment for full details.
Generated by Expert Code Review (auto) for issue #249 · ● 12.8M
| code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }} | ||
| code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }} | ||
| comment_id: ${{ steps.process_safe_outputs.outputs.comment_id }} | ||
| comment_url: ${{ steps.process_safe_outputs.outputs.comment_url }} | ||
| create_discussion_error_count: ${{ steps.process_safe_outputs.outputs.create_discussion_error_count }} | ||
| create_discussion_errors: ${{ steps.process_safe_outputs.outputs.create_discussion_errors }} |
There was a problem hiding this comment.
🟢 MINOR · 2/3 consensus
These four output declarations (code_push_failure_count, code_push_failure_errors, create_discussion_error_count, create_discussion_errors) are now stale — create_pull_request and create_discussion tools were removed, so these will always be empty strings with no consumers.
Suggestion: Remove these dead output lines to keep the workflow self-documenting and avoid confusion.
- Remove create-pull-request (token can't push to docs-maui) - Remove add-comment for 'no docs needed' (silent skip instead) - Remove checkout of docs-maui (not needed for issue creation) - Issue body is self-contained with source PR link, summary, affected pages, and suggested ready for an agenticchanges workflow on the docs-maui side to pick up Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: jfversluis <939291+jfversluis@users.noreply.github.com>
Simplifies the pr-docs-check workflow:workflow