Skip to content

docs: paste the security review into the PR instead of citing its local path - #134

Merged
stevecastaneda merged 1 commit into
mainfrom
docs-security-review-in-pr
Nov 7, 2026
Merged

stevecastaneda merged 1 commit into
mainfrom
docs-security-review-in-pr

Conversation

@stevecastaneda

Copy link
Copy Markdown
Owner

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.

…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.
@stevecastaneda
stevecastaneda merged commit dc25063 into main Nov 7, 2026
1 check passed
@stevecastaneda
stevecastaneda deleted the docs-security-review-in-pr branch November 7, 2026 17:22
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.

1 participant