-
Notifications
You must be signed in to change notification settings - Fork 0
chore: Updated security workflow readme #7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: ssharma/security-review-github-action
Are you sure you want to change the base?
chore: Updated security workflow readme #7
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs-only PR; no code changes to validate. No additional P0/P1 bugs introduced by this diff.
Note: an existing review thread suggests removing the @droid review security command mention from README if that’s not supported/desired behavior.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs-only PR; no new P0/P1 issues found in this diff. (Existing threads about command naming/mentioning have been resolved.)
…urity-review-readme
|
Droid finished @shashank-factory's task —— View job |
|
|
||
| - `@droid fill` — turns a bare pull request into a polished description that matches your template or our opinionated fallback. | ||
| - `@droid review` — performs an automated code review, surfaces potential bugs, and leaves inline comments directly on the diff. | ||
| - `@droid security` — performs an automated security review using STRIDE methodology, identifying vulnerabilities and suggesting fixes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[P1] Document the correct security command name
Repo code/tests and action.yml reference @droid security-review (and @droid review security), but this README documents @droid security; users will invoke the wrong command and the workflow won’t trigger as expected.
| | `automatic_security_review` | `false` | Automatically run security review on PRs without requiring `@droid security`. | | ||
| | `security_model` | `""` | Override the model used for security review. Falls back to `review_model` if not set. | | ||
| | `security_severity_threshold` | `medium` | Minimum severity to report (`critical`, `high`, `medium`, `low`). Findings below this threshold are filtered out. | | ||
| | `security_block_on_critical` | `true` | Submit `REQUEST_CHANGES` review when critical severity findings are detected. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[P1] Avoid promising REQUEST_CHANGES from composite action
README claims the security action will submit REQUEST_CHANGES on critical/high, but GitHub Actions tokens generally can’t create “request changes” reviews; promising this behavior is likely incorrect and will mislead users configuring enforcement.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs change looks directionally right, but it currently documents a security command name/behavior that doesn’t match what the repo code/tests/action inputs expect, which will cause users to invoke unsupported commands. Please align README with the implemented trigger(s) and avoid promising enforcement behavior that GitHub Actions can’t perform.
Summary
Updates the README.md to document the new security workflow capabilities and the modular sub-action architecture introduced for parallel code and security reviews.
Changes
@droid security,@droid review security, and@droid security --fullcommandsprepare,review,security,combine)automatic_security_reviewsecurity_modelsecurity_severity_thresholdsecurity_block_on_critical/highsecurity_notify_teamsecurity_scan_schedule/daysFactory-AI/droid-action/prepare,/review,/security,/combine)*to-for consistencyTesting
Documentation-only changes. No code changes to test.
Related Issues
closes https://linear.app/factoryai/issue/FAC-14927/update-readme-with-new-structure-around-the-security-workflow