You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: action/README.md
+30Lines changed: 30 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,11 @@ This repository is the Marketplace-facing wrapper for the scanner action. The ma
12
12
13
13
The default Marketplace install path uses an exact `codex-plugin-scanner` PyPI release, verifies its PyPI provenance against `hashgraph-online/codex-plugin-scanner`, and only then installs it. After installation, the default `scan`, `lint`, and offline `verify` paths operate on local repository content only. Live network probing and submission automation remain explicit opt-in features.
14
14
15
+
Advanced distribution paths are available when you need them:
16
+
17
+
-`install_source: local` is the explicit dogfood path for `uses: ./action` inside the source repo.
18
+
-`ghcr.io/hashgraph-online/codex-plugin-scanner` is the container distribution for enterprise runners that prefer a reviewed OCI image over runtime package installation.
19
+
15
20
## Usage
16
21
17
22
```yaml
@@ -44,6 +49,7 @@ The default Marketplace install path uses an exact `codex-plugin-scanner` PyPI r
| `install_cisco` | Install the opt-in Cisco skill-scanner dependency used by this repo | `false` |
52
+
| `install_source` | Package install source: `pypi`for the reviewed release path, or `local` for source-repo dogfooding | `pypi` |
47
53
| `submission_enabled` | Open submission issues for awesome-list and registry automation when the plugin clears the submission threshold | `false` |
48
54
| `submission_score_threshold` | Minimum score required before a submission issue is created | `80` |
49
55
| `submission_repos` | Comma-separated GitHub repositories that should receive the submission issue | `hashgraph-online/awesome-codex-plugins` |
@@ -127,6 +133,17 @@ This `plugin_dir: "."` pattern is correct for both single-plugin repositories an
127
133
install_cisco: true
128
134
```
129
135
136
+
### Dogfood the source-repo action bundle
137
+
138
+
Use this only inside `hashgraph-online/codex-plugin-scanner`, where the action can install the adjacent source tree directly.
139
+
140
+
```yaml
141
+
- uses: ./action
142
+
with:
143
+
plugin_dir: "."
144
+
install_source: local
145
+
```
146
+
130
147
### Export registry payload for Codex ecosystem automation
131
148
132
149
```yaml
@@ -236,3 +253,16 @@ Set `mode` to one of `scan`, `lint`, `verify`, or `submit`.
236
253
For `submit` mode, point `plugin_dir` at one concrete plugin directory. Repository-mode discovery is supported for `scan`, `lint`, and `verify`, but `submit` intentionally remains single-plugin.
237
254
238
255
For `scan` mode, set `upload_sarif: true` to emit and upload SARIF automatically instead of wiring a separate upload step by hand.
256
+
257
+
## Container Distribution
258
+
259
+
The scanner is also published as an OCI image for container-first environments:
The image installs the scanner from the reviewed source tree at release build time. It is separate from the Marketplace action so teams that prefer `docker://` or explicit `docker run` flows can use a pinned image without changing the secure default action path.
0 commit comments