docs: reframe scanner section as CI quality gate#24
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the README to modernize the plugin validation workflow, replacing standard pip installation instructions with pipx run and simplifying the GitHub Action configuration. Review feedback highlights a potential execution failure in the local preflight instructions due to missing pipx prefixes and suggests capitalization improvements for consistency in the new submission preflight list.
README.md
Outdated
| pipx run codex-plugin-scanner lint . | ||
| codex-plugin-scanner verify . |
There was a problem hiding this comment.
The command codex-plugin-scanner verify . will fail if the user relies on pipx run from the previous line, as pipx run executes the package in a temporary environment without adding it to the system PATH. To ensure both commands work correctly without a permanent installation, both should be prefixed with pipx run.
| pipx run codex-plugin-scanner lint . | |
| codex-plugin-scanner verify . | |
| pipx run codex-plugin-scanner lint . | |
| pipx run codex-plugin-scanner verify . |
README.md
Outdated
| - structural lint results | ||
| - publish-readiness verification output | ||
| - SARIF/findings for CI and code scanning |
There was a problem hiding this comment.
For consistency with other lists in this document, such as the 'Official Plugins' and 'Plugin Trust Scores' sections, the items in this list should start with a capital letter.
| - structural lint results | |
| - publish-readiness verification output | |
| - SARIF/findings for CI and code scanning | |
| - Structural lint results | |
| - Publish-readiness verification output | |
| - SARIF/findings for CI and code scanning |
![kilo-code-bot[bot]](https://avatars.githubusercontent.com/in/2193792?s=60&v=4){kind=small}
README.md
Outdated
| pip install codex-plugin-scanner | ||
| codex-plugin-scanner ./my-plugin | ||
| pipx run codex-plugin-scanner lint . | ||
| codex-plugin-scanner verify . |
There was a problem hiding this comment.
SUGGESTION: Inconsistent invocation — lint uses pipx run but verify does not
The first command pipx run codex-plugin-scanner lint . implies the tool is not installed globally, yet the second command codex-plugin-scanner verify . assumes it is. Both should use the same invocation method to avoid confusing users.
| codex-plugin-scanner verify . | |
| pipx run codex-plugin-scanner verify . |
Code Review SummaryStatus: No Issues Found | Recommendation: Merge Changes Since Last Review
Files Reviewed (2 files)
Reviewed by mimo-v2-pro-20260318 · 117,430 tokens |
README.md
Outdated
|
|
||
| ```bash | ||
| pipx run codex-plugin-scanner lint . | ||
| codex-plugin-scanner verify . |
There was a problem hiding this comment.
SUGGESTION: Inconsistent invocation — lint uses pipx run but verify does not
The first command uses pipx run codex-plugin-scanner lint . but the second drops the pipx run prefix. This is the same inconsistency flagged on line 151 in the "Validate Before You Ship" section. Pick one convention and apply it to both commands.
| codex-plugin-scanner verify . | |
| pipx run codex-plugin-scanner verify . |
2 participants
update readme