docs(scan): state the history behaviour in every caller - #32
Merged
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
There was a problem hiding this comment.
🟢 Approval recommended
The changes are limited to comment/documentation updates within the workflow and do not introduce behavioral or configuration changes.
Pull request overview
Updates the local Scan workflow caller documentation to accurately describe how the shared scan operates across triggers, improving consistency and avoiding misleading guidance.
Changes:
- Rewrites the workflow header comment to state that PR scans include full history due to the shared baseline using
fetch-depth: 0. - Clarifies the purpose of the weekly schedule as re-scanning unchanged code against updated detector rules.
- Corrects the Renovate note to explain that the shared preset intentionally disables updates for
uinaf/.github, making pinning ineffective.
File summaries
| File | Description |
|---|---|
| .github/workflows/scan.yml | Updates caller comments to correctly explain PR history behavior and Renovate behavior for the shared workflow reference. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
![slopzapper[bot]](https://avatars.githubusercontent.com/in/4527847?s=60&v=4){kind=small}
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.
Problem
The previous pass did not land everywhere. It matched one hard-coded two-line comment, so callers whose comment was a single line, or worded differently, kept the old text claiming the weekly schedule is what "covers history". Where it did land, the phrasing garden-paths and the checkout input was written without its colon.
Solution
Rewrite the header in every caller, preserving each repository's own reason for having no push trigger, and state plainly that pull requests scan full history because the shared baseline checks out with
fetch-depth: 0. Also correct the reference note: nothing prevents Renovate from updatinguinaf/.github, the shared preset deliberately disables it.