Nightly scanner should be less nit-picky about docs#1921
Merged
derekmisler merged 1 commit intodocker:mainfrom Mar 4, 2026
Merged
Conversation
Signed-off-by: Derek Misler <derek.misler@docker.com>
There was a problem hiding this comment.
Review Summary
Assessment: 🟢 APPROVE
This PR successfully scopes the nightly scanner's documentation agent to only analyze markdown files and fixes a pipefail crash in the auto-issue-triage workflow.
Changes reviewed:
- ✅ Documentation agent now explicitly scoped to
.mdfiles only with clear instructions to ignore source code - ✅ High-impact-only criteria properly defined (factually incorrect info, missing setup steps, broken critical links)
- ✅ grep command correctly fixed with
|| trueto prevent pipefail crashes when no RESULT marker is found
All changes are correct. The grep fix properly handles the case where the pattern is not found by setting an empty string, which falls through to the else block that sets action=none. No bugs detected in the changed code.
Findings
No issues found. The code changes work as intended.
dgageot
approved these changes
Mar 4, 2026
krissetto
reviewed
Mar 4, 2026
| description: Documentation gaps and improvements | ||
| instruction: | | ||
| You analyze code for documentation issues. Only report significant gaps. | ||
| You analyze markdown documentation files for issues. Only report significant gaps. |
Contributor
There was a problem hiding this comment.
shouldn't we maybe expand it to the actual gh pages style docs as well?
Contributor
Author
There was a problem hiding this comment.
Those were just turned into markdown files, so I think this'll work? I'll keep an eye on it.
krissetto
approved these changes
Mar 4, 2026
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.
Summary
The nightly codebase scanner's documentation agent was filing issues about missing doc comments in Go source files (e.g., #1912). This PR scopes the documentation agent to only analyze
.mdfiles, raises the bar so it only reports high-impact issues, and fixes apipefailcrash in the auto-issue-triage workflow.Changes
Nightly scanner documentation agent (
nightly-scanner.yaml):.mdfiles only — source code doc comments are no longer in scopeNO_ISSUESdirective so findings only get reported if they would genuinely block or mislead a contributorAuto-issue-triage workflow (
auto-issue-triage.yml):grepexit code 1 causing the "Parse agent result" step to fail under bashpipefailwhen the agent output contains noRESULT:marker (e.g., this run)Test plan
workflow_dispatchwith dry-run=true) and verify the documentation agent only analyzes.mdfiles