oss-signal 0.4.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +18 -2
- package/README.md +66 -15
- package/action.yml +8 -5
- package/docs/adoption-evidence.md +64 -11
- package/docs/codex-for-oss-application.md +36 -17
- package/docs/codex-for-oss-form-answers.md +101 -0
- package/docs/examples/github-action-workflow.yml +1 -1
- package/docs/examples/github-code-scanning-workflow.yml +2 -2
- package/docs/examples/github-inventory-workflow.yml +27 -0
- package/docs/examples/github-issue-body.md +37 -0
- package/docs/examples/github-url-report.md +1 -1
- package/docs/examples/inventory-report.md +14 -0
- package/docs/examples/inventory-targets.txt +5 -0
- package/docs/examples/self-audit.sarif +2 -2
- package/docs/maintainer-playbook.md +29 -3
- package/docs/outreach/README.md +1 -0
- package/docs/outreach/flox-install-flox-action-issue-draft.md +24 -0
- package/docs/outreach/flox-install-flox-action-report.md +45 -0
- package/docs/release-notes/v0.5.0.md +22 -0
- package/docs/release-notes/v0.5.1.md +22 -0
- package/docs/release-notes/v0.6.0.md +23 -0
- package/docs/release-process.md +15 -2
- package/docs/reviewer-evidence.md +74 -0
- package/docs/self-audit.md +1 -1
- package/package.json +1 -1
- package/src/action.js +117 -17
- package/src/cli.js +86 -14
- package/src/index.js +125 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,11 +2,27 @@
|
|
|
2
2
|
|
|
3
3
|
## Unreleased
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
5
|
+
## 0.6.0
|
|
6
|
+
|
|
7
|
+
- Added repository inventory mode for auditing newline-delimited lists of local paths, GitHub URLs, and `owner/repo` shorthands.
|
|
8
|
+
- Added GitHub Action inventory support with step summary output and average-score Action outputs.
|
|
9
|
+
- Added inventory examples, reviewer verification steps, and maintainer playbook guidance.
|
|
10
|
+
|
|
11
|
+
## 0.5.1
|
|
12
|
+
|
|
13
|
+
- Published the Issue-ready output release on a clean tag after release workflow hardening.
|
|
14
|
+
- Guarded automatic npm publishing behind an explicit repository variable.
|
|
15
|
+
|
|
16
|
+
## 0.5.0
|
|
17
|
+
|
|
18
|
+
- Added `--format issue` for generating human-reviewed GitHub Issue bodies from audit findings.
|
|
19
|
+
- Added an issue-output example and maintainer playbook guidance for audit-to-issue workflows.
|
|
7
20
|
|
|
8
21
|
## 0.4.0
|
|
9
22
|
|
|
23
|
+
- Added a maintainer playbook for audit-to-issue, PR, CI gate, and SARIF workflows.
|
|
24
|
+
- Added a documented release process and tag-triggered release workflow with npm dry-run verification.
|
|
25
|
+
|
|
10
26
|
- Added SARIF output for GitHub Code Scanning and other security dashboards.
|
|
11
27
|
- Added Action support for `format: sarif`.
|
|
12
28
|
|
package/README.md
CHANGED
|
@@ -9,10 +9,22 @@
|
|
|
9
9
|
|
|
10
10
|
`oss-signal` is a dependency-light CLI for auditing open-source repository maintenance readiness.
|
|
11
11
|
|
|
12
|
-
It checks the files and automation that reduce maintainer load: README, license, contributing guide, security policy, CI, tests, issue templates, pull request templates, Dependabot, and release notes. The output is a score plus concrete next steps in Markdown, JSON, or
|
|
12
|
+
It checks the files and automation that reduce maintainer load: README, license, contributing guide, security policy, CI, tests, issue templates, pull request templates, Dependabot, and release notes. The output is a score plus concrete next steps in Markdown, JSON, SARIF, or a GitHub Issue-ready Markdown body.
|
|
13
13
|
|
|
14
14
|

|
|
15
15
|
|
|
16
|
+
## Maintainer Evidence Snapshot
|
|
17
|
+
|
|
18
|
+
Public evidence for the maintainer workflow is collected in [docs/reviewer-evidence.md](docs/reviewer-evidence.md) and [docs/adoption-evidence.md](docs/adoption-evidence.md).
|
|
19
|
+
|
|
20
|
+
- Published package: [`oss-signal@0.6.0`](https://www.npmjs.com/package/oss-signal), with `latest` pointing at `0.6.0`.
|
|
21
|
+
- Published GitHub Action: [`SalmonPlays/oss-signal@v0.6.0`](https://github.com/SalmonPlays/oss-signal/tree/v0.6.0).
|
|
22
|
+
- Public checks: CI, Repository health, and CodeQL are passing on `main`.
|
|
23
|
+
- Self-audit: this repository scores **100/100 (A)** locally and through GitHub URL mode.
|
|
24
|
+
- Field use: four public maintainer-readiness audits have been turned into four issues and four focused follow-up PRs.
|
|
25
|
+
- Inventory mode: the CLI and Action can audit a newline-delimited list of repositories for organization-level triage.
|
|
26
|
+
- Separate workflow demo: [oss-signal-adoption-demo](https://github.com/SalmonPlays/oss-signal-adoption-demo/actions/runs/26883001038) runs the public Action tag and uploads Markdown, SARIF, and Issue-ready artifacts.
|
|
27
|
+
|
|
16
28
|
## Why
|
|
17
29
|
|
|
18
30
|
Open-source projects often fail quietly because the maintainer workflow is undocumented. `oss-signal` gives maintainers a repeatable checklist they can run locally, in CI, or before asking contributors to help.
|
|
@@ -75,6 +87,14 @@ Use JSON in automation:
|
|
|
75
87
|
oss-signal . --format json --fail-under 80
|
|
76
88
|
```
|
|
77
89
|
|
|
90
|
+
Audit multiple repositories from one newline-delimited inventory file:
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
oss-signal --inventory docs/examples/inventory-targets.txt --format markdown --output inventory-report.md
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
See [docs/examples/inventory-report.md](docs/examples/inventory-report.md) for a generated inventory report.
|
|
97
|
+
|
|
78
98
|
Write SARIF for GitHub Code Scanning or other dashboards:
|
|
79
99
|
|
|
80
100
|
```bash
|
|
@@ -87,6 +107,12 @@ Generate a report that can be attached to an issue:
|
|
|
87
107
|
oss-signal . --format markdown --output docs/maintainer-readiness.md
|
|
88
108
|
```
|
|
89
109
|
|
|
110
|
+
Generate a maintainer-friendly issue body:
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
oss-signal platformatic/massimo --format issue --output maintainer-follow-up.md
|
|
114
|
+
```
|
|
115
|
+
|
|
90
116
|
## Checks
|
|
91
117
|
|
|
92
118
|
`oss-signal` currently checks:
|
|
@@ -97,7 +123,7 @@ oss-signal . --format markdown --output docs/maintainer-readiness.md
|
|
|
97
123
|
|
|
98
124
|
See [docs/rules.md](docs/rules.md) for rule details and scoring weights.
|
|
99
125
|
|
|
100
|
-
SARIF output reports failed maintainer-readiness checks as warning-level results. This lets teams upload the audit to code scanning dashboards while keeping the Markdown report available for maintainers.
|
|
126
|
+
SARIF output reports failed maintainer-readiness checks as warning-level results. This lets teams upload the audit to code scanning dashboards while keeping the Markdown report available for maintainers. Issue output turns the same findings into a human-reviewed checklist that can be edited before posting.
|
|
101
127
|
|
|
102
128
|
For GitHub URL audits, `oss-signal` reads the repository file tree through the GitHub API and also uses GitHub's community profile signal when available. This lets it detect organization-level files such as a shared code of conduct.
|
|
103
129
|
|
|
@@ -114,21 +140,24 @@ Summary:
|
|
|
114
140
|
- Total checks: 15
|
|
115
141
|
```
|
|
116
142
|
|
|
117
|
-
See [docs/self-audit.md](docs/self-audit.md) for the full local self-audit report, [docs/examples/github-url-report.md](docs/examples/github-url-report.md) for the GitHub URL audit output, and [docs/examples/self-audit.sarif](docs/examples/self-audit.sarif) for SARIF output.
|
|
143
|
+
See [docs/self-audit.md](docs/self-audit.md) for the full local self-audit report, [docs/examples/github-url-report.md](docs/examples/github-url-report.md) for the GitHub URL audit output, [docs/examples/github-issue-body.md](docs/examples/github-issue-body.md) for issue output, and [docs/examples/self-audit.sarif](docs/examples/self-audit.sarif) for SARIF output.
|
|
118
144
|
|
|
119
|
-
The [Repository health workflow](.github/workflows/repository-health.yml) runs `SalmonPlays/oss-signal@v0.
|
|
145
|
+
The [Repository health workflow](.github/workflows/repository-health.yml) runs `SalmonPlays/oss-signal@v0.6.0`, uploads the Markdown report as an artifact, and uploads SARIF to GitHub Code Scanning on non-PR runs. The [Repository inventory workflow](.github/workflows/repository-inventory.yml) runs the inventory mode from CI and uploads a multi-repository report artifact.
|
|
120
146
|
|
|
121
147
|
## Field Audits
|
|
122
148
|
|
|
123
|
-
`oss-signal` has been run against public repositories to produce maintainer-readiness reports
|
|
149
|
+
`oss-signal` has been run against public repositories to produce maintainer-readiness reports, respectful issue drafts, and focused follow-up PRs:
|
|
124
150
|
|
|
125
|
-
- [platformatic/massimo report](docs/outreach/platformatic-massimo-report.md)
|
|
126
|
-
- [supermarkt/checkjebon report](docs/outreach/supermarkt-checkjebon-report.md)
|
|
127
|
-
- [sammorrisdesign/interactive-feed report](docs/outreach/sammorrisdesign-interactive-feed-report.md)
|
|
151
|
+
- [platformatic/massimo report](docs/outreach/platformatic-massimo-report.md), [issue #159](https://github.com/platformatic/massimo/issues/159), and [PR #160](https://github.com/platformatic/massimo/pull/160)
|
|
152
|
+
- [supermarkt/checkjebon report](docs/outreach/supermarkt-checkjebon-report.md), [issue #22](https://github.com/supermarkt/checkjebon/issues/22), and [PR #23](https://github.com/supermarkt/checkjebon/pull/23)
|
|
153
|
+
- [sammorrisdesign/interactive-feed report](docs/outreach/sammorrisdesign-interactive-feed-report.md), [issue #14](https://github.com/sammorrisdesign/interactive-feed/issues/14), and [PR #15](https://github.com/sammorrisdesign/interactive-feed/pull/15)
|
|
154
|
+
- [flox/install-flox-action report](docs/outreach/flox-install-flox-action-report.md), [issue #204](https://github.com/flox/install-flox-action/issues/204), and [PR #205](https://github.com/flox/install-flox-action/pull/205)
|
|
128
155
|
|
|
129
156
|
See [docs/outreach](docs/outreach) for the reports and draft issue text. Drafts are not posted automatically; maintainers should only receive specific, useful, and respectful suggestions.
|
|
130
157
|
|
|
131
|
-
For a compact maintainer/adoption summary, see [docs/adoption-evidence.md](docs/adoption-evidence.md).
|
|
158
|
+
For a compact maintainer/adoption summary, see [docs/adoption-evidence.md](docs/adoption-evidence.md). For a reviewer-oriented verification path, see [docs/reviewer-evidence.md](docs/reviewer-evidence.md).
|
|
159
|
+
|
|
160
|
+
Separate public workflow evidence: [SalmonPlays/oss-signal-adoption-demo](https://github.com/SalmonPlays/oss-signal-adoption-demo) runs `SalmonPlays/oss-signal@v0.5.1` and produced a successful [workflow run](https://github.com/SalmonPlays/oss-signal-adoption-demo/actions/runs/26883001038) with Markdown, SARIF, and Issue-ready report artifacts.
|
|
132
161
|
|
|
133
162
|
## Example Recommendation Output
|
|
134
163
|
|
|
@@ -157,7 +186,7 @@ oss-signal . --fail-under 80
|
|
|
157
186
|
Add `oss-signal` directly to a GitHub Actions workflow:
|
|
158
187
|
|
|
159
188
|
```yaml
|
|
160
|
-
- uses: SalmonPlays/oss-signal@v0.
|
|
189
|
+
- uses: SalmonPlays/oss-signal@v0.6.0
|
|
161
190
|
id: oss-signal
|
|
162
191
|
with:
|
|
163
192
|
fail-under: "80"
|
|
@@ -170,6 +199,28 @@ The Action writes a concise GitHub Actions step summary by default, so reviewers
|
|
|
170
199
|
|
|
171
200
|

|
|
172
201
|
|
|
202
|
+
Run an inventory from CI:
|
|
203
|
+
|
|
204
|
+
```yaml
|
|
205
|
+
- uses: SalmonPlays/oss-signal@v0.6.0
|
|
206
|
+
env:
|
|
207
|
+
GITHUB_TOKEN: ${{ github.token }}
|
|
208
|
+
with:
|
|
209
|
+
inventory: docs/examples/inventory-targets.txt
|
|
210
|
+
output: inventory-report.md
|
|
211
|
+
summary: "true"
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
Generate an editable Issue body from CI:
|
|
215
|
+
|
|
216
|
+
```yaml
|
|
217
|
+
- uses: SalmonPlays/oss-signal@v0.6.0
|
|
218
|
+
with:
|
|
219
|
+
format: issue
|
|
220
|
+
output: maintainer-follow-up.md
|
|
221
|
+
summary: "true"
|
|
222
|
+
```
|
|
223
|
+
|
|
173
224
|
Full workflow example:
|
|
174
225
|
|
|
175
226
|
```yaml
|
|
@@ -185,7 +236,7 @@ jobs:
|
|
|
185
236
|
runs-on: ubuntu-latest
|
|
186
237
|
steps:
|
|
187
238
|
- uses: actions/checkout@v4
|
|
188
|
-
- uses: SalmonPlays/oss-signal@v0.
|
|
239
|
+
- uses: SalmonPlays/oss-signal@v0.6.0
|
|
189
240
|
id: oss-signal
|
|
190
241
|
with:
|
|
191
242
|
fail-under: "80"
|
|
@@ -197,7 +248,7 @@ jobs:
|
|
|
197
248
|
path: oss-signal-report.md
|
|
198
249
|
```
|
|
199
250
|
|
|
200
|
-
See [docs/examples/github-action-workflow.yml](docs/examples/github-action-workflow.yml) for a copyable workflow and [docs/examples/github-code-scanning-workflow.yml](docs/examples/github-code-scanning-workflow.yml) for a workflow that uploads SARIF to GitHub Code Scanning.
|
|
251
|
+
See [docs/examples/github-action-workflow.yml](docs/examples/github-action-workflow.yml) for a copyable workflow, [docs/examples/github-inventory-workflow.yml](docs/examples/github-inventory-workflow.yml) for an inventory workflow, and [docs/examples/github-code-scanning-workflow.yml](docs/examples/github-code-scanning-workflow.yml) for a workflow that uploads SARIF to GitHub Code Scanning.
|
|
201
252
|
|
|
202
253
|
Upload SARIF to GitHub Code Scanning:
|
|
203
254
|
|
|
@@ -208,7 +259,7 @@ permissions:
|
|
|
208
259
|
|
|
209
260
|
steps:
|
|
210
261
|
- uses: actions/checkout@v4
|
|
211
|
-
- uses: SalmonPlays/oss-signal@v0.
|
|
262
|
+
- uses: SalmonPlays/oss-signal@v0.6.0
|
|
212
263
|
with:
|
|
213
264
|
format: sarif
|
|
214
265
|
output: oss-signal.sarif
|
|
@@ -218,7 +269,7 @@ steps:
|
|
|
218
269
|
sarif_file: oss-signal.sarif
|
|
219
270
|
```
|
|
220
271
|
|
|
221
|
-
This repository dogfoods the public Action tag in [Repository health](.github/workflows/repository-health.yml), which runs `SalmonPlays/oss-signal@v0.
|
|
272
|
+
This repository dogfoods the public Action tag in [Repository health](.github/workflows/repository-health.yml), which runs `SalmonPlays/oss-signal@v0.6.0` against the repository, uploads the Markdown report artifact, and publishes SARIF to Code Scanning on non-PR runs.
|
|
222
273
|
|
|
223
274
|
You can also run the CLI directly in CI:
|
|
224
275
|
|
|
@@ -237,7 +288,7 @@ You can also run the CLI directly in CI:
|
|
|
237
288
|
- Ecosystem-specific profiles for Python, Rust, Go, and JavaScript packages
|
|
238
289
|
- Release automation and provenance metadata checks
|
|
239
290
|
- Maintainer score trends over time
|
|
240
|
-
- Organization-level repository inventory
|
|
291
|
+
- Organization-level repository inventory dashboards
|
|
241
292
|
|
|
242
293
|
## Release Process
|
|
243
294
|
|
package/action.yml
CHANGED
|
@@ -9,8 +9,11 @@ inputs:
|
|
|
9
9
|
description: Local repository path, GitHub URL, or owner/repo shorthand to audit.
|
|
10
10
|
required: false
|
|
11
11
|
default: "."
|
|
12
|
+
inventory:
|
|
13
|
+
description: Newline-delimited file of local paths, GitHub URLs, or owner/repo shorthands to audit as an inventory.
|
|
14
|
+
required: false
|
|
12
15
|
format:
|
|
13
|
-
description: Output format, either markdown, json, or
|
|
16
|
+
description: Output format, either markdown, json, sarif, or issue. Inventory mode supports markdown or json.
|
|
14
17
|
required: false
|
|
15
18
|
default: markdown
|
|
16
19
|
output:
|
|
@@ -22,7 +25,7 @@ inputs:
|
|
|
22
25
|
required: false
|
|
23
26
|
default: "true"
|
|
24
27
|
fail-under:
|
|
25
|
-
description: Fail the action when the score is below this number.
|
|
28
|
+
description: Fail the action when the score, or any inventory target score, is below this number.
|
|
26
29
|
required: false
|
|
27
30
|
max-files:
|
|
28
31
|
description: Maximum files to inspect.
|
|
@@ -33,11 +36,11 @@ inputs:
|
|
|
33
36
|
required: false
|
|
34
37
|
outputs:
|
|
35
38
|
score:
|
|
36
|
-
description: Numeric maintainer-readiness score.
|
|
39
|
+
description: Numeric maintainer-readiness score, or average score in inventory mode.
|
|
37
40
|
grade:
|
|
38
|
-
description: Letter grade for the maintainer-readiness score.
|
|
41
|
+
description: Letter grade for the maintainer-readiness score, or average grade in inventory mode.
|
|
39
42
|
failed:
|
|
40
|
-
description: Number of failed checks.
|
|
43
|
+
description: Number of failed checks, or total failed checks in inventory mode.
|
|
41
44
|
report-path:
|
|
42
45
|
description: Path to the generated report file, when output is enabled.
|
|
43
46
|
runs:
|
|
@@ -2,21 +2,30 @@
|
|
|
2
2
|
|
|
3
3
|
This page collects the public evidence that `oss-signal` is built for real open-source maintainer workflows.
|
|
4
4
|
|
|
5
|
+
Last verified: 2026-06-03T12:45:11Z
|
|
6
|
+
|
|
5
7
|
## Project Links
|
|
6
8
|
|
|
7
9
|
- Repository: https://github.com/SalmonPlays/oss-signal
|
|
8
|
-
- npm package: https://www.npmjs.com/package/oss-signal (`0.
|
|
9
|
-
- GitHub Release: https://github.com/SalmonPlays/oss-signal/releases/tag/v0.
|
|
10
|
-
- GitHub Action tag: https://github.com/SalmonPlays/oss-signal/tree/v0.
|
|
10
|
+
- npm package: https://www.npmjs.com/package/oss-signal (`0.6.0` latest)
|
|
11
|
+
- GitHub Release: https://github.com/SalmonPlays/oss-signal/releases/tag/v0.6.0
|
|
12
|
+
- GitHub Action tag: https://github.com/SalmonPlays/oss-signal/tree/v0.6.0
|
|
11
13
|
- GitHub Action metadata: [action.yml](../action.yml)
|
|
12
14
|
- Public dogfood workflow: [.github/workflows/repository-health.yml](../.github/workflows/repository-health.yml)
|
|
15
|
+
- Public inventory workflow: [.github/workflows/repository-inventory.yml](../.github/workflows/repository-inventory.yml)
|
|
16
|
+
- Separate public workflow demo: https://github.com/SalmonPlays/oss-signal-adoption-demo
|
|
17
|
+
- Separate public workflow run: https://github.com/SalmonPlays/oss-signal-adoption-demo/actions/runs/26883001038
|
|
13
18
|
- Self-audit report: [docs/self-audit.md](self-audit.md)
|
|
14
19
|
- SARIF self-audit output: [docs/examples/self-audit.sarif](examples/self-audit.sarif)
|
|
15
20
|
- GitHub URL audit report: [docs/examples/github-url-report.md](examples/github-url-report.md)
|
|
16
21
|
- GitHub Action workflow example: [docs/examples/github-action-workflow.yml](examples/github-action-workflow.yml)
|
|
22
|
+
- Inventory target example: [docs/examples/inventory-targets.txt](examples/inventory-targets.txt)
|
|
23
|
+
- Inventory report example: [docs/examples/inventory-report.md](examples/inventory-report.md)
|
|
17
24
|
- Maintainer playbook: [docs/maintainer-playbook.md](maintainer-playbook.md)
|
|
25
|
+
- Reviewer evidence quickstart: [docs/reviewer-evidence.md](reviewer-evidence.md)
|
|
18
26
|
- Release process: [docs/release-process.md](release-process.md)
|
|
19
27
|
- Codex for Open Source application brief: [docs/codex-for-oss-application.md](codex-for-oss-application.md)
|
|
28
|
+
- Codex for Open Source form answers: [docs/codex-for-oss-form-answers.md](codex-for-oss-form-answers.md)
|
|
20
29
|
- Rule reference: [docs/rules.md](rules.md)
|
|
21
30
|
|
|
22
31
|
## Maintainer Use Case
|
|
@@ -27,23 +36,64 @@ The CLI supports two practical modes:
|
|
|
27
36
|
|
|
28
37
|
- Local repository audit for maintainers working in a clone.
|
|
29
38
|
- Public GitHub repository audit for quick triage without cloning.
|
|
39
|
+
- Repository inventory audit for maintainers comparing several repositories at once.
|
|
30
40
|
|
|
31
|
-
It also ships as a GitHub Action, so maintainers can gate repository hygiene in CI, show the result in the GitHub Actions step summary, upload a Markdown report as a workflow artifact, and upload failed maintainer-readiness checks as SARIF for GitHub Code Scanning. This repository dogfoods the public Action tag through the Repository health
|
|
41
|
+
It also ships as a GitHub Action, so maintainers can gate repository hygiene in CI, show the result in the GitHub Actions step summary, upload a Markdown report as a workflow artifact, run inventory reports, and upload failed maintainer-readiness checks as SARIF for GitHub Code Scanning. This repository dogfoods the public Action tag through the Repository health and Repository inventory workflows.
|
|
32
42
|
|
|
33
43
|
The [maintainer playbook](maintainer-playbook.md) documents the end-to-end workflow from audit to issue, pull request, CI gate, and Code Scanning evidence. The [release process](release-process.md) documents pre-release verification, tag consistency, npm publish checks, and post-release smoke tests.
|
|
34
44
|
|
|
45
|
+
## Published Package Verification
|
|
46
|
+
|
|
47
|
+
The npm package is publicly available as `oss-signal@0.6.0` with `latest` pointing at `0.6.0`.
|
|
48
|
+
|
|
49
|
+
The npm downloads API returned 356 downloads for both last-week and last-month windows on 2026-06-03. Download counts can lag publication, so this is treated as supporting evidence rather than proof of broad adoption.
|
|
50
|
+
|
|
51
|
+
Clean-directory execution against the public GitHub repository returned:
|
|
52
|
+
|
|
53
|
+
```json
|
|
54
|
+
{
|
|
55
|
+
"version": "0.6.0",
|
|
56
|
+
"score": 100,
|
|
57
|
+
"grade": "A",
|
|
58
|
+
"source": "github"
|
|
59
|
+
}
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Current public workflow status:
|
|
63
|
+
|
|
64
|
+
- CI: passing
|
|
65
|
+
- Repository health: passing
|
|
66
|
+
- CodeQL: passing
|
|
67
|
+
- Release: passing
|
|
68
|
+
- Separate public workflow demo: passing
|
|
69
|
+
|
|
70
|
+
The npm registry returned `0.6.0` for both the package version and `latest` dist-tag on 2026-06-03T12:45:11Z. The same check returned 356 downloads for the last-week and last-month windows.
|
|
71
|
+
|
|
72
|
+
## Separate Public Workflow Evidence
|
|
73
|
+
|
|
74
|
+
The public repository https://github.com/SalmonPlays/oss-signal-adoption-demo runs `SalmonPlays/oss-signal@v0.5.1` from a separate workflow file:
|
|
75
|
+
|
|
76
|
+
- Workflow file: https://github.com/SalmonPlays/oss-signal-adoption-demo/blob/main/.github/workflows/oss-signal.yml
|
|
77
|
+
- Successful workflow run: https://github.com/SalmonPlays/oss-signal-adoption-demo/actions/runs/26883001038
|
|
78
|
+
- Artifact: `oss-signal-adoption-demo-report`, containing `oss-signal-report.md`, `oss-signal.sarif`, and `maintainer-follow-up.md`
|
|
79
|
+
|
|
80
|
+
This is not claimed as independent third-party adoption because the repository is owned by `SalmonPlays`. It is evidence that the public `v0.5.1` Action tag works outside the main repository and can publish Markdown, SARIF, and Issue-ready maintainer-readiness reports from another public workflow.
|
|
81
|
+
|
|
35
82
|
## Public Field Audits And PRs
|
|
36
83
|
|
|
37
84
|
The tool has been used to generate maintainer-readiness reports for public repositories and convert them into respectful cleanup issues:
|
|
38
85
|
|
|
39
|
-
| Repository | Report | Posted issue | Follow-up PR |
|
|
40
|
-
| --- | --- | --- | --- |
|
|
41
|
-
| `platformatic/massimo` | [report](outreach/platformatic-massimo-report.md) | https://github.com/platformatic/massimo/issues/159 | https://github.com/platformatic/massimo/pull/160 |
|
|
42
|
-
| `supermarkt/checkjebon` | [report](outreach/supermarkt-checkjebon-report.md) | https://github.com/supermarkt/checkjebon/issues/22 | https://github.com/supermarkt/checkjebon/pull/23 |
|
|
43
|
-
| `sammorrisdesign/interactive-feed` | [report](outreach/sammorrisdesign-interactive-feed-report.md) | https://github.com/sammorrisdesign/interactive-feed/issues/14 | https://github.com/sammorrisdesign/interactive-feed/pull/15 |
|
|
86
|
+
| Repository | Report | Posted issue | Follow-up PR | Status |
|
|
87
|
+
| --- | --- | --- | --- | --- |
|
|
88
|
+
| `platformatic/massimo` | [report](outreach/platformatic-massimo-report.md) | https://github.com/platformatic/massimo/issues/159 | https://github.com/platformatic/massimo/pull/160 | open, clean |
|
|
89
|
+
| `supermarkt/checkjebon` | [report](outreach/supermarkt-checkjebon-report.md) | https://github.com/supermarkt/checkjebon/issues/22 | https://github.com/supermarkt/checkjebon/pull/23 | open, clean |
|
|
90
|
+
| `sammorrisdesign/interactive-feed` | [report](outreach/sammorrisdesign-interactive-feed-report.md) | https://github.com/sammorrisdesign/interactive-feed/issues/14 | https://github.com/sammorrisdesign/interactive-feed/pull/15 | open |
|
|
91
|
+
| `flox/install-flox-action` | [report](outreach/flox-install-flox-action-report.md) | https://github.com/flox/install-flox-action/issues/204 | https://github.com/flox/install-flox-action/pull/205 | open, checks pending |
|
|
44
92
|
|
|
45
93
|
These issues and pull requests are evidence of the intended maintainer workflow: run a deterministic audit, explain the missing signals, and give maintainers a small set of actionable improvements. Each PR is intentionally limited to documentation or GitHub templates.
|
|
46
94
|
|
|
95
|
+
All four follow-up PRs were still open when checked from GitHub on 2026-06-03T12:33:45Z. They are not claimed as accepted adoption unless a maintainer merges or otherwise endorses them.
|
|
96
|
+
|
|
47
97
|
## Verification Commands
|
|
48
98
|
|
|
49
99
|
From this repository:
|
|
@@ -52,17 +102,20 @@ From this repository:
|
|
|
52
102
|
npm run check
|
|
53
103
|
npm run audit:github
|
|
54
104
|
node src/cli.js . --format sarif --output docs/examples/self-audit.sarif
|
|
105
|
+
node src/cli.js --inventory docs/examples/inventory-targets.txt --format markdown --output docs/examples/inventory-report.md
|
|
55
106
|
node src/cli.js platformatic/massimo --format json
|
|
56
|
-
|
|
107
|
+
npm exec --yes --package=oss-signal@0.6.0 -- oss-signal SalmonPlays/oss-signal --format json
|
|
57
108
|
```
|
|
58
109
|
|
|
59
|
-
The current repository self-audit score is 100/100, the GitHub community profile health score is 100, and CI verifies the local GitHub Action wrapper. The public `v0.
|
|
110
|
+
The current repository self-audit score is 100/100, the GitHub community profile health score is 100, and CI verifies the local GitHub Action wrapper. The public `v0.6.0` Action tag is used by the repository health workflow for Markdown and SARIF output. The published npm `0.6.0` package has also been executed from a clean temporary directory against the public GitHub repository, returning 100/100 (A).
|
|
60
111
|
|
|
61
112
|
Public CI evidence:
|
|
62
113
|
|
|
63
114
|
- CI workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/ci.yml
|
|
64
115
|
- Repository health workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/repository-health.yml
|
|
65
116
|
- CodeQL workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/codeql.yml
|
|
117
|
+
- Separate workflow demo run: https://github.com/SalmonPlays/oss-signal-adoption-demo/actions/runs/26883001038
|
|
118
|
+
- Reviewer verification quickstart: [reviewer-evidence.md](reviewer-evidence.md)
|
|
66
119
|
|
|
67
120
|
## Boundaries
|
|
68
121
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Codex for Open Source Application Brief
|
|
2
2
|
|
|
3
|
-
Snapshot: 2026-06-
|
|
3
|
+
Snapshot: 2026-06-03T12:45:11Z
|
|
4
4
|
|
|
5
5
|
This document summarizes why `oss-signal` is a fit for OpenAI's Codex for Open Source program. The official program page says open-source maintainers can apply, with emphasis on core maintainers, widely used public projects, and projects that play an important ecosystem role: https://developers.openai.com/community/codex-for-oss
|
|
6
6
|
|
|
@@ -8,12 +8,16 @@ This document summarizes why `oss-signal` is a fit for OpenAI's Codex for Open S
|
|
|
8
8
|
|
|
9
9
|
- Repository: https://github.com/SalmonPlays/oss-signal
|
|
10
10
|
- npm package: https://www.npmjs.com/package/oss-signal
|
|
11
|
-
- GitHub Release: https://github.com/SalmonPlays/oss-signal/releases/tag/v0.
|
|
12
|
-
- GitHub Action tag: https://github.com/SalmonPlays/oss-signal/tree/v0.
|
|
11
|
+
- GitHub Release: https://github.com/SalmonPlays/oss-signal/releases/tag/v0.6.0
|
|
12
|
+
- GitHub Action tag: https://github.com/SalmonPlays/oss-signal/tree/v0.6.0
|
|
13
13
|
- CI workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/ci.yml
|
|
14
14
|
- Repository health workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/repository-health.yml
|
|
15
|
+
- Repository inventory workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/repository-inventory.yml
|
|
15
16
|
- CodeQL workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/codeql.yml
|
|
17
|
+
- Separate public workflow demo: https://github.com/SalmonPlays/oss-signal-adoption-demo/actions/runs/26883001038
|
|
16
18
|
- Maintainer evidence: [adoption-evidence.md](adoption-evidence.md)
|
|
19
|
+
- Reviewer evidence quickstart: [reviewer-evidence.md](reviewer-evidence.md)
|
|
20
|
+
- Form answer pack: [codex-for-oss-form-answers.md](codex-for-oss-form-answers.md)
|
|
17
21
|
- Maintainer playbook: [maintainer-playbook.md](maintainer-playbook.md)
|
|
18
22
|
- Release process: [release-process.md](release-process.md)
|
|
19
23
|
|
|
@@ -25,13 +29,14 @@ This document summarizes why `oss-signal` is a fit for OpenAI's Codex for Open S
|
|
|
25
29
|
- CI, tests, issue templates, pull request templates, Dependabot, and CodeQL-style security workflow.
|
|
26
30
|
- Package metadata and lockfile hygiene.
|
|
27
31
|
|
|
28
|
-
The output is a deterministic score plus actionable next steps in Markdown, JSON, or
|
|
32
|
+
The output is a deterministic score plus actionable next steps in Markdown, JSON, SARIF, or an Issue-ready Markdown body. The GitHub Action also writes a workflow step summary so maintainers and reviewers can see the result without downloading an artifact.
|
|
29
33
|
|
|
30
34
|
## Why Codex Helps
|
|
31
35
|
|
|
32
36
|
This project is designed around repeatable maintainer workflows where Codex is useful:
|
|
33
37
|
|
|
34
38
|
- Run audits against public repositories without cloning.
|
|
39
|
+
- Compare several repositories with an inventory report.
|
|
35
40
|
- Convert findings into focused cleanup issues or pull requests.
|
|
36
41
|
- Keep repository hygiene visible in CI.
|
|
37
42
|
- Upload failed maintainer-readiness checks to GitHub Code Scanning through SARIF.
|
|
@@ -42,26 +47,38 @@ This project is designed around repeatable maintainer workflows where Codex is u
|
|
|
42
47
|
|
|
43
48
|
The repository currently has:
|
|
44
49
|
|
|
45
|
-
- A published npm package with `0.
|
|
46
|
-
-
|
|
50
|
+
- A published npm package with `0.6.0` as the latest release.
|
|
51
|
+
- npm download API evidence showing 356 last-week and last-month downloads on 2026-06-03.
|
|
52
|
+
- A published GitHub Release for v0.6.0 with repository inventory release notes and CI usage guidance.
|
|
47
53
|
- A reusable GitHub Action with `score`, `grade`, `failed`, and `report-path` outputs.
|
|
54
|
+
- A repository inventory mode for organization-level maintainer-readiness triage, available in both CLI and GitHub Action form.
|
|
55
|
+
- A clean npm smoke test of `oss-signal@0.6.0` returning version `0.6.0`, score `100`, grade `A`, and source `github`.
|
|
48
56
|
- SARIF output for GitHub Code Scanning integration.
|
|
49
|
-
- A v0.
|
|
50
|
-
- A public dogfood workflow that runs `SalmonPlays/oss-signal@v0.
|
|
57
|
+
- A v0.6.0 GitHub Action tag with step summary, SARIF support, inventory support, and Issue-ready output.
|
|
58
|
+
- A public dogfood workflow that runs `SalmonPlays/oss-signal@v0.6.0` against the repository, uploads the Markdown report artifact, and uploads SARIF to GitHub Code Scanning on non-PR runs.
|
|
59
|
+
- A public dogfood inventory workflow that runs `SalmonPlays/oss-signal@v0.6.0` against a repository target list and uploads an inventory artifact.
|
|
60
|
+
- A separate public workflow demo that runs `SalmonPlays/oss-signal@v0.5.1` from another repository and uploads Markdown, SARIF, and Issue-ready report artifacts.
|
|
51
61
|
- A maintainer playbook that documents audit, triage, issue, PR, CI, and SARIF workflows.
|
|
52
62
|
- A release process and tag-triggered release workflow that verify package contents and support npm provenance publishing when repository secrets are configured.
|
|
53
|
-
- CI
|
|
63
|
+
- CI, Repository health, CodeQL, and Release workflows passing publicly.
|
|
54
64
|
- A local self-audit score of 100/100.
|
|
55
|
-
- A clean-directory smoke test of `
|
|
56
|
-
- Public reports, issues, and PRs created from real repository audits.
|
|
65
|
+
- A clean-directory smoke test of `npm exec --yes --package=oss-signal@0.6.0 -- oss-signal SalmonPlays/oss-signal --format json`, returning 100/100 (A).
|
|
66
|
+
- Public reports, issues, and PRs created from real repository audits, including four posted field-audit issues and four follow-up PRs.
|
|
67
|
+
|
|
68
|
+
## Separate Workflow Demo
|
|
69
|
+
|
|
70
|
+
The repository https://github.com/SalmonPlays/oss-signal-adoption-demo runs the public `SalmonPlays/oss-signal@v0.5.1` Action tag from a separate workflow. The successful run at https://github.com/SalmonPlays/oss-signal-adoption-demo/actions/runs/26883001038 uploaded an `oss-signal-adoption-demo-report` artifact containing Markdown, SARIF, and Issue-ready output.
|
|
71
|
+
|
|
72
|
+
This is intentionally described as a separate public workflow demo rather than third-party adoption because the repository is also owned by `SalmonPlays`. It still proves that the published Action tag is consumable outside the main repository.
|
|
57
73
|
|
|
58
74
|
## Field Audits And Follow-Up PRs
|
|
59
75
|
|
|
60
76
|
| Repository | Report | Issue | PR | Status |
|
|
61
77
|
| --- | --- | --- | --- | --- |
|
|
62
|
-
| `platformatic/massimo` | [report](outreach/platformatic-massimo-report.md) | https://github.com/platformatic/massimo/issues/159 | https://github.com/platformatic/massimo/pull/160 | open,
|
|
63
|
-
| `supermarkt/checkjebon` | [report](outreach/supermarkt-checkjebon-report.md) | https://github.com/supermarkt/checkjebon/issues/22 | https://github.com/supermarkt/checkjebon/pull/23 | open,
|
|
64
|
-
| `sammorrisdesign/interactive-feed` | [report](outreach/sammorrisdesign-interactive-feed-report.md) | https://github.com/sammorrisdesign/interactive-feed/issues/14 | https://github.com/sammorrisdesign/interactive-feed/pull/15 | open
|
|
78
|
+
| `platformatic/massimo` | [report](outreach/platformatic-massimo-report.md) | https://github.com/platformatic/massimo/issues/159 | https://github.com/platformatic/massimo/pull/160 | open, clean |
|
|
79
|
+
| `supermarkt/checkjebon` | [report](outreach/supermarkt-checkjebon-report.md) | https://github.com/supermarkt/checkjebon/issues/22 | https://github.com/supermarkt/checkjebon/pull/23 | open, clean |
|
|
80
|
+
| `sammorrisdesign/interactive-feed` | [report](outreach/sammorrisdesign-interactive-feed-report.md) | https://github.com/sammorrisdesign/interactive-feed/issues/14 | https://github.com/sammorrisdesign/interactive-feed/pull/15 | open |
|
|
81
|
+
| `flox/install-flox-action` | [report](outreach/flox-install-flox-action-report.md) | https://github.com/flox/install-flox-action/issues/204 | https://github.com/flox/install-flox-action/pull/205 | open, checks pending |
|
|
65
82
|
|
|
66
83
|
These PRs are intentionally small and maintainer-friendly. They add documentation or GitHub templates rather than changing product code.
|
|
67
84
|
|
|
@@ -69,16 +86,18 @@ These PRs are intentionally small and maintainer-friendly. They add documentatio
|
|
|
69
86
|
|
|
70
87
|
Recommended application angle:
|
|
71
88
|
|
|
72
|
-
`oss-signal` is not yet a widely adopted project, but it is a public OSS maintainer tool built specifically for repeatable Codex-assisted maintenance. The project already has a working CLI, npm distribution, GitHub Action, passing CI/CodeQL, self-audit evidence, and
|
|
89
|
+
`oss-signal` is not yet a widely adopted project, but it is a public OSS maintainer tool built specifically for repeatable Codex-assisted maintenance. The project already has a working CLI, npm distribution, GitHub Action, passing CI/CodeQL, self-audit evidence, four public field-audit issues, and four public field-audit PRs. Codex support would be used to continue auditing repositories, prepare focused maintainer PRs, improve Action automation, and document repeatable OSS maintenance workflows.
|
|
90
|
+
|
|
91
|
+
Prepared official form answers are in [codex-for-oss-form-answers.md](codex-for-oss-form-answers.md). The applicant still needs to fill personal identity fields and their OpenAI Organization ID directly.
|
|
73
92
|
|
|
74
93
|
## Current Gaps
|
|
75
94
|
|
|
76
95
|
- External PRs are open but not yet merged.
|
|
77
96
|
- npm download metrics are still early because the package is newly published.
|
|
78
|
-
- The project needs
|
|
97
|
+
- The project needs independent maintainer-owned repositories using the Action in their own workflows.
|
|
79
98
|
|
|
80
99
|
## Next Evidence To Collect
|
|
81
100
|
|
|
82
101
|
- One or more merged external PRs.
|
|
83
|
-
- A public workflow run in
|
|
102
|
+
- A public workflow run in an independent maintainer-owned repository using `SalmonPlays/oss-signal@v0.6.0`, ideally with SARIF or inventory upload enabled.
|
|
84
103
|
- npm download data once the registry starts reporting weekly/monthly counts.
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# Codex for Open Source Form Answers
|
|
2
|
+
|
|
3
|
+
Snapshot: 2026-06-03T12:45:11Z
|
|
4
|
+
|
|
5
|
+
This page prepares concise answers for the official Codex for Open Source application form: https://openai.com/form/codex-for-oss/
|
|
6
|
+
|
|
7
|
+
The official form asks for personal identity fields that must be filled by the applicant:
|
|
8
|
+
|
|
9
|
+
- First name
|
|
10
|
+
- Last name
|
|
11
|
+
- Email associated with the applicant's ChatGPT account
|
|
12
|
+
- OpenAI Organization ID
|
|
13
|
+
|
|
14
|
+
## First Name
|
|
15
|
+
|
|
16
|
+
```text
|
|
17
|
+
Fill manually.
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Last Name
|
|
21
|
+
|
|
22
|
+
```text
|
|
23
|
+
Fill manually.
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Email
|
|
27
|
+
|
|
28
|
+
```text
|
|
29
|
+
Fill manually with the email associated with the applicant's ChatGPT account.
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## GitHub Username
|
|
33
|
+
|
|
34
|
+
```text
|
|
35
|
+
SalmonPlays
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## GitHub Repository URL
|
|
39
|
+
|
|
40
|
+
```text
|
|
41
|
+
https://github.com/SalmonPlays/oss-signal
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Describe Your Role
|
|
45
|
+
|
|
46
|
+
```text
|
|
47
|
+
Primary maintainer
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Why This Repository Qualifies
|
|
51
|
+
|
|
52
|
+
```text
|
|
53
|
+
oss-signal is a public OSS maintainer tool for reducing triage and review load. It ships as npm package oss-signal@0.6.0 and GitHub Action SalmonPlays/oss-signal@v0.6.0, supports Markdown/JSON/SARIF/Issue/Inventory output, passes CI/CodeQL/Release, has a 100/100 self-audit, and has four public field-audit issues plus four PRs.
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Interest
|
|
57
|
+
|
|
58
|
+
```text
|
|
59
|
+
Codex Security
|
|
60
|
+
API credits for my project
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Codex Security Use
|
|
64
|
+
|
|
65
|
+
```text
|
|
66
|
+
Use Codex Security to review oss-signal's CLI, GitHub Action, SARIF output, and repository-audit workflow for vulnerabilities before maintainers rely on it in CI. The project analyzes public repository metadata and writes reports, so security coverage helps catch unsafe workflow assumptions, dependency issues, and action-handling risks before field-audit PRs are shared with other OSS maintainers.
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## OpenAI Organization ID
|
|
70
|
+
|
|
71
|
+
```text
|
|
72
|
+
Fill manually from https://platform.openai.com/settings/organization/general
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## API Credit Use
|
|
76
|
+
|
|
77
|
+
```text
|
|
78
|
+
Use Codex/API credits to run repeatable public repository audits, draft focused maintainer PRs and issue summaries from reports, build organization-level maintainer-readiness inventories, improve release/Code Scanning automation, and keep every public follow-up behind human review before posting or opening PRs.
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Anything Else
|
|
82
|
+
|
|
83
|
+
```text
|
|
84
|
+
The project is early, so I am not overstating adoption. Current evidence includes npm 0.6.0 latest, 356 npm downloads reported by the registry API, a published v0.6.0 release, a reusable GitHub Action with inventory mode, a clean npm smoke test returning 100/A, public CI/Repository health/CodeQL/Release, four field-audit issues, four PRs, and a workflow demo with artifacts.
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## Evidence Links
|
|
88
|
+
|
|
89
|
+
- npm package: https://www.npmjs.com/package/oss-signal
|
|
90
|
+
- GitHub Release v0.6.0: https://github.com/SalmonPlays/oss-signal/releases/tag/v0.6.0
|
|
91
|
+
- Main repository health workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/repository-health.yml
|
|
92
|
+
- Separate workflow demo repository: https://github.com/SalmonPlays/oss-signal-adoption-demo
|
|
93
|
+
- Separate successful workflow run: https://github.com/SalmonPlays/oss-signal-adoption-demo/actions/runs/26883001038
|
|
94
|
+
- Adoption evidence: https://github.com/SalmonPlays/oss-signal/blob/main/docs/adoption-evidence.md
|
|
95
|
+
|
|
96
|
+
## Character Counts
|
|
97
|
+
|
|
98
|
+
- Why this repository qualifies: 328/500
|
|
99
|
+
- Codex Security use: 399/500
|
|
100
|
+
- API credit use: 312/500
|
|
101
|
+
- Anything else: 376/500
|
|
@@ -15,13 +15,13 @@ jobs:
|
|
|
15
15
|
runs-on: ubuntu-latest
|
|
16
16
|
steps:
|
|
17
17
|
- uses: actions/checkout@v4
|
|
18
|
-
- uses: SalmonPlays/oss-signal@v0.
|
|
18
|
+
- uses: SalmonPlays/oss-signal@v0.6.0
|
|
19
19
|
id: oss-signal
|
|
20
20
|
with:
|
|
21
21
|
fail-under: "80"
|
|
22
22
|
output: oss-signal-report.md
|
|
23
23
|
summary: "true"
|
|
24
|
-
- uses: SalmonPlays/oss-signal@v0.
|
|
24
|
+
- uses: SalmonPlays/oss-signal@v0.6.0
|
|
25
25
|
with:
|
|
26
26
|
format: sarif
|
|
27
27
|
output: oss-signal.sarif
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
name: Repository inventory
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
workflow_dispatch:
|
|
5
|
+
schedule:
|
|
6
|
+
- cron: "0 9 * * 1"
|
|
7
|
+
|
|
8
|
+
permissions:
|
|
9
|
+
contents: read
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
inventory:
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v4
|
|
16
|
+
- uses: SalmonPlays/oss-signal@v0.6.0
|
|
17
|
+
id: oss-signal
|
|
18
|
+
env:
|
|
19
|
+
GITHUB_TOKEN: ${{ github.token }}
|
|
20
|
+
with:
|
|
21
|
+
inventory: docs/examples/inventory-targets.txt
|
|
22
|
+
output: inventory-report.md
|
|
23
|
+
summary: "true"
|
|
24
|
+
- uses: actions/upload-artifact@v4
|
|
25
|
+
with:
|
|
26
|
+
name: oss-signal-inventory-report
|
|
27
|
+
path: inventory-report.md
|