cli: add review workflow plan command - #160
Conversation
Signed-off-by: Prachi Agrawal <prachi194agrawal@gmail.com>
There was a problem hiding this comment.
Pull request overview
Adds a new read-only security-triage review plan CLI subcommand that prints the local dry-run + human-gated review/apply workflow (optionally to a Markdown file), making it easier to inspect the intended workflow before running any actions.
Changes:
- Introduces
security-triage review planand wires it into the CLI dispatch and argument parser. - Adds a Markdown renderer that prints a curated end-to-end command sequence (discovery/cleanup → review render/create → review apply).
- Adds CLI tests and documents the new command in
README.md.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
tests/test_cli.py |
Adds tests for review plan registration, required repo enforcement, stdout output, and file output behavior. |
src/security_triage/reporting.py |
Adds render_review_plan_markdown() to generate the plan Markdown content. |
src/security_triage/cli.py |
Adds the review plan subcommand, parser args, and run_review_plan_command() implementation. |
README.md |
Documents how to print the workflow plan via security-triage review plan. |
|
How this one differs from |
@Prachi194agrawal just following up on Daniel's comment. Can you answer so we can figure out if we should close this out or not. |
|
Thanks @danielszot , @LexiNadolski for the follow-up.
So the intent was to help new contributors/operators understand the human-gated workflow before they have generated any reports. That said, I understand the concern that this may be too much extra CLI surface if the same guidance is better kept in the README. If you think |
|
I wouldn't add a code that is not necessary, let's keep it simple wherever we can. |
Summary
Adds a new read-only
security-triage review plancommand that prints the local dry-run and human-gated review/apply workflow for the Flatcar security triage assistant.This supports flatcar/Flatcar#2200 by making the AI-assisted security triage flow easier for contributors and maintainers to inspect before any GitHub or model calls are made.
What changed
security-triage review planREADME.mdTesting