Repository navigation
docs: paste the security review into the PR instead of citing its local path - #134
Merged
Merged
Conversation
…al path The report lives on the machine that ran the review, so a path in the PR body means nothing to anyone reading it on GitHub, and the next review of the same plugin version overwrites the file.
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.
Why
Each plugin PR is supposed to show its security review, but the rule said to put the report's path in the PR body. That path only exists on the machine that ran the review, so nobody reading the PR on GitHub can open it.
Reports are also named by plugin version, so the next review of the same version overwrites the file. That already happened: the zod review in #133 replaced
progress-1.14.4.md, so PR #132 now points at a different review than the one it describes.What changes
AGENTS.md and CONTRIBUTING.md now say to put the verdict line in the PR body and paste the full report below it in a collapsed
<details>section, and not to cite the path.No plugin changes, so there's no security review or version bump.