Skip to content

fix: Docs-check reliable issues, no noise - #249

Merged
jfversluis merged 1 commit into
mainfrom
fix/docs-check-issues-only
May 6, 2026
Merged

fix: Docs-check reliable issues, no noise#249
jfversluis merged 1 commit into
mainfrom
fix/docs-check-issues-only

Conversation

@jfversluis

Copy link
Copy Markdown
Member

Simplifies the pr-docs-check workflow:workflow

  • Issue-only output (no cross-repo push needed)
  • Silent skip when no docs needed (no 'no docs needed' comments)
  • Self-contained issue body for downstream agentic workflow on docs-maui
  • No labels (avoids permission issues)

Copilot AI review requested due to automatic review settings May 6, 2026 21:10
- 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>
@jfversluis
jfversluis force-pushed the fix/docs-check-issues-only branch from d1977f1 to 07230ca Compare May 6, 2026 21:12

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 to create_issue targeting dotnet/docs-maui.
  • Remove the secondary docs-maui checkout 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.

@jfversluis
jfversluis merged commit e946f1d into main May 6, 2026
1 check passed
@jfversluis
jfversluis deleted the fix/docs-check-issues-only branch May 6, 2026 21:18
@github-actions

github-actions Bot commented May 6, 2026

Copy link
Copy Markdown
Contributor

Expert Code Review — PR #249

Methodology: 3 independent reviewers with adversarial consensus

2 findings (1 posted inline, 1 in overflow below) — both 🟢 minor.

Overflow (line outside diff — cannot post inline)

# Severity Consensus File Line(s) Finding
2 🟢 Minor 2/3 .github/workflows/pr-docs-check.lock.yml ~1086 (outside diff) The noop tool is still offered and GH_AW_NOOP_REPORT_AS_ISSUE: "true" is set in the conclusion job. If the agent calls noop when skipping (common for transparency), it may surface a visible message — contradicting the "no noise / stop silently" intent. Consider setting GH_AW_NOOP_REPORT_AS_ISSUE: "false" or clarifying in the prompt that noop should not be called when skipping.

Discarded findings (did not reach consensus)

  • Labels schema still exposed (1/3, Reviewer 3 only) — both follow-up reviewers disagreed: the field is optional and the prompt never instructs label use; GitHub API behavior and framework auto-generation make this a non-issue.
  • Timeout reduction 20→15 may cause false negatives (1/3, Reviewer 3 only) — both follow-up reviewers disagreed: the dramatically reduced workload (issue creation vs. full PR authoring) makes 15 min generous.
  • safe_outputs no longer depends on activation (1/3, Reviewer 2 only) — both follow-up reviewers disagreed: transitive dependency through agent → activation preserves ordering; safe_outputs doesn't consume any activation outputs.

CI Status

  • license/cla — passed

Test Coverage

N/A — this PR modifies only workflow YAML and Markdown (no source code or tests applicable).


Generated by Expert Code Review · 3 independent reviewers with adversarial consensus

Generated by Expert Code Review (auto) for issue #249 · ● 12.8M ·

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment on lines 1135 to 1138
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 }}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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.

Copilot AI pushed a commit that referenced this pull request May 12, 2026
- 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants