oss-signal 0.3.0 → 0.5.1
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 +20 -0
- package/README.md +70 -9
- package/action.yml +1 -1
- package/docs/adoption-evidence.md +26 -4
- package/docs/codex-for-oss-application.md +28 -9
- package/docs/codex-for-oss-form-answers.md +94 -0
- package/docs/examples/github-action-workflow.yml +1 -1
- package/docs/examples/github-code-scanning-workflow.yml +38 -0
- package/docs/examples/github-issue-body.md +37 -0
- package/docs/examples/github-url-report.md +1 -1
- package/docs/examples/self-audit.sarif +407 -0
- package/docs/maintainer-playbook.md +111 -0
- package/docs/release-notes/v0.4.0.md +26 -0
- package/docs/release-notes/v0.5.0.md +22 -0
- package/docs/release-notes/v0.5.1.md +22 -0
- package/docs/release-process.md +89 -0
- package/docs/self-audit.md +1 -1
- package/package.json +1 -1
- package/src/action.js +17 -4
- package/src/cli.js +19 -5
- package/src/index.js +147 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,25 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## Unreleased
|
|
4
|
+
|
|
5
|
+
## 0.5.1
|
|
6
|
+
|
|
7
|
+
- Published the Issue-ready output release on a clean tag after release workflow hardening.
|
|
8
|
+
- Guarded automatic npm publishing behind an explicit repository variable.
|
|
9
|
+
|
|
10
|
+
## 0.5.0
|
|
11
|
+
|
|
12
|
+
- Added `--format issue` for generating human-reviewed GitHub Issue bodies from audit findings.
|
|
13
|
+
- Added an issue-output example and maintainer playbook guidance for audit-to-issue workflows.
|
|
14
|
+
|
|
15
|
+
## 0.4.0
|
|
16
|
+
|
|
17
|
+
- Added a maintainer playbook for audit-to-issue, PR, CI gate, and SARIF workflows.
|
|
18
|
+
- Added a documented release process and tag-triggered release workflow with npm dry-run verification.
|
|
19
|
+
|
|
20
|
+
- Added SARIF output for GitHub Code Scanning and other security dashboards.
|
|
21
|
+
- Added Action support for `format: sarif`.
|
|
22
|
+
|
|
3
23
|
## 0.3.0
|
|
4
24
|
|
|
5
25
|
- Added GitHub Actions step summary output for readable workflow reports.
|
package/README.md
CHANGED
|
@@ -2,13 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://github.com/SalmonPlays/oss-signal/actions/workflows/ci.yml)
|
|
4
4
|
[](https://github.com/SalmonPlays/oss-signal/actions/workflows/repository-health.yml)
|
|
5
|
+
[](https://github.com/SalmonPlays/oss-signal/releases/latest)
|
|
5
6
|
[](https://www.npmjs.com/package/oss-signal)
|
|
6
7
|
[](https://www.npmjs.com/package/oss-signal)
|
|
7
8
|
[](LICENSE)
|
|
8
9
|
|
|
9
10
|
`oss-signal` is a dependency-light CLI for auditing open-source repository maintenance readiness.
|
|
10
11
|
|
|
11
|
-
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 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.
|
|
12
13
|
|
|
13
14
|

|
|
14
15
|
|
|
@@ -24,12 +25,20 @@ Open-source projects often fail quietly because the maintainer workflow is undoc
|
|
|
24
25
|
- Foundations and working groups can compare repository hygiene across many projects.
|
|
25
26
|
- CI maintainers can add it as a GitHub Action, show the score in the workflow summary, and publish the report as an artifact.
|
|
26
27
|
|
|
28
|
+
See [docs/maintainer-playbook.md](docs/maintainer-playbook.md) for a concrete maintainer workflow from audit to issue, PR, CI gate, and Code Scanning evidence.
|
|
29
|
+
|
|
27
30
|
## Install
|
|
28
31
|
|
|
29
32
|
```bash
|
|
30
33
|
npm install --global oss-signal
|
|
31
34
|
```
|
|
32
35
|
|
|
36
|
+
Try it without installing:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npx oss-signal SalmonPlays/oss-signal
|
|
40
|
+
```
|
|
41
|
+
|
|
33
42
|
For local development:
|
|
34
43
|
|
|
35
44
|
```bash
|
|
@@ -66,12 +75,24 @@ Use JSON in automation:
|
|
|
66
75
|
oss-signal . --format json --fail-under 80
|
|
67
76
|
```
|
|
68
77
|
|
|
78
|
+
Write SARIF for GitHub Code Scanning or other dashboards:
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
oss-signal . --format sarif --output oss-signal.sarif
|
|
82
|
+
```
|
|
83
|
+
|
|
69
84
|
Generate a report that can be attached to an issue:
|
|
70
85
|
|
|
71
86
|
```bash
|
|
72
87
|
oss-signal . --format markdown --output docs/maintainer-readiness.md
|
|
73
88
|
```
|
|
74
89
|
|
|
90
|
+
Generate a maintainer-friendly issue body:
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
oss-signal platformatic/massimo --format issue --output maintainer-follow-up.md
|
|
94
|
+
```
|
|
95
|
+
|
|
75
96
|
## Checks
|
|
76
97
|
|
|
77
98
|
`oss-signal` currently checks:
|
|
@@ -82,11 +103,13 @@ oss-signal . --format markdown --output docs/maintainer-readiness.md
|
|
|
82
103
|
|
|
83
104
|
See [docs/rules.md](docs/rules.md) for rule details and scoring weights.
|
|
84
105
|
|
|
106
|
+
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.
|
|
107
|
+
|
|
85
108
|
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.
|
|
86
109
|
|
|
87
110
|
## Real Output
|
|
88
111
|
|
|
89
|
-
This repository audits itself at **100/100 (A)
|
|
112
|
+
This repository audits itself at **100/100 (A)** and dogfoods the public GitHub Action:
|
|
90
113
|
|
|
91
114
|
```text
|
|
92
115
|
Score: 100/100 (A)
|
|
@@ -97,7 +120,9 @@ Summary:
|
|
|
97
120
|
- Total checks: 15
|
|
98
121
|
```
|
|
99
122
|
|
|
100
|
-
See [docs/self-audit.md](docs/self-audit.md) for the full local self-audit report
|
|
123
|
+
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.
|
|
124
|
+
|
|
125
|
+
The [Repository health workflow](.github/workflows/repository-health.yml) runs `SalmonPlays/oss-signal@v0.5.1`, uploads the Markdown report as an artifact, and uploads SARIF to GitHub Code Scanning on non-PR runs.
|
|
101
126
|
|
|
102
127
|
## Field Audits
|
|
103
128
|
|
|
@@ -111,6 +136,8 @@ See [docs/outreach](docs/outreach) for the reports and draft issue text. Drafts
|
|
|
111
136
|
|
|
112
137
|
For a compact maintainer/adoption summary, see [docs/adoption-evidence.md](docs/adoption-evidence.md).
|
|
113
138
|
|
|
139
|
+
Separate public workflow evidence: [SalmonPlays/oss-signal-adoption-demo](https://github.com/SalmonPlays/oss-signal-adoption-demo) runs `SalmonPlays/oss-signal@v0.4.0` and produced a successful [workflow run](https://github.com/SalmonPlays/oss-signal-adoption-demo/actions/runs/26862361229) with a report artifact.
|
|
140
|
+
|
|
114
141
|
## Example Recommendation Output
|
|
115
142
|
|
|
116
143
|
```text
|
|
@@ -138,7 +165,7 @@ oss-signal . --fail-under 80
|
|
|
138
165
|
Add `oss-signal` directly to a GitHub Actions workflow:
|
|
139
166
|
|
|
140
167
|
```yaml
|
|
141
|
-
- uses: SalmonPlays/oss-signal@v0.
|
|
168
|
+
- uses: SalmonPlays/oss-signal@v0.5.1
|
|
142
169
|
id: oss-signal
|
|
143
170
|
with:
|
|
144
171
|
fail-under: "80"
|
|
@@ -151,6 +178,16 @@ The Action writes a concise GitHub Actions step summary by default, so reviewers
|
|
|
151
178
|
|
|
152
179
|

|
|
153
180
|
|
|
181
|
+
Generate an editable Issue body from CI:
|
|
182
|
+
|
|
183
|
+
```yaml
|
|
184
|
+
- uses: SalmonPlays/oss-signal@v0.5.1
|
|
185
|
+
with:
|
|
186
|
+
format: issue
|
|
187
|
+
output: maintainer-follow-up.md
|
|
188
|
+
summary: "true"
|
|
189
|
+
```
|
|
190
|
+
|
|
154
191
|
Full workflow example:
|
|
155
192
|
|
|
156
193
|
```yaml
|
|
@@ -166,7 +203,7 @@ jobs:
|
|
|
166
203
|
runs-on: ubuntu-latest
|
|
167
204
|
steps:
|
|
168
205
|
- uses: actions/checkout@v4
|
|
169
|
-
- uses: SalmonPlays/oss-signal@v0.
|
|
206
|
+
- uses: SalmonPlays/oss-signal@v0.5.1
|
|
170
207
|
id: oss-signal
|
|
171
208
|
with:
|
|
172
209
|
fail-under: "80"
|
|
@@ -178,9 +215,28 @@ jobs:
|
|
|
178
215
|
path: oss-signal-report.md
|
|
179
216
|
```
|
|
180
217
|
|
|
181
|
-
See [docs/examples/github-action-workflow.yml](docs/examples/github-action-workflow.yml) for a copyable workflow.
|
|
218
|
+
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.
|
|
219
|
+
|
|
220
|
+
Upload SARIF to GitHub Code Scanning:
|
|
182
221
|
|
|
183
|
-
|
|
222
|
+
```yaml
|
|
223
|
+
permissions:
|
|
224
|
+
contents: read
|
|
225
|
+
security-events: write
|
|
226
|
+
|
|
227
|
+
steps:
|
|
228
|
+
- uses: actions/checkout@v4
|
|
229
|
+
- uses: SalmonPlays/oss-signal@v0.5.1
|
|
230
|
+
with:
|
|
231
|
+
format: sarif
|
|
232
|
+
output: oss-signal.sarif
|
|
233
|
+
summary: "true"
|
|
234
|
+
- uses: github/codeql-action/upload-sarif@v3
|
|
235
|
+
with:
|
|
236
|
+
sarif_file: oss-signal.sarif
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
This repository dogfoods the public Action tag in [Repository health](.github/workflows/repository-health.yml), which runs `SalmonPlays/oss-signal@v0.5.1` against the repository, uploads the Markdown report artifact, and publishes SARIF to Code Scanning on non-PR runs.
|
|
184
240
|
|
|
185
241
|
You can also run the CLI directly in CI:
|
|
186
242
|
|
|
@@ -197,8 +253,13 @@ You can also run the CLI directly in CI:
|
|
|
197
253
|
## Roadmap
|
|
198
254
|
|
|
199
255
|
- Ecosystem-specific profiles for Python, Rust, Go, and JavaScript packages
|
|
200
|
-
-
|
|
201
|
-
-
|
|
256
|
+
- Release automation and provenance metadata checks
|
|
257
|
+
- Maintainer score trends over time
|
|
258
|
+
- Organization-level repository inventory reports
|
|
259
|
+
|
|
260
|
+
## Release Process
|
|
261
|
+
|
|
262
|
+
Releases use the checklist in [docs/release-process.md](docs/release-process.md). The repository also includes a tag-triggered [release workflow](.github/workflows/release.yml) that verifies the package, runs `npm publish --dry-run`, and can publish to npm with provenance when `NPM_TOKEN` is configured.
|
|
202
263
|
|
|
203
264
|
## Contributing
|
|
204
265
|
|
package/action.yml
CHANGED
|
@@ -5,14 +5,21 @@ This page collects the public evidence that `oss-signal` is built for real open-
|
|
|
5
5
|
## Project Links
|
|
6
6
|
|
|
7
7
|
- Repository: https://github.com/SalmonPlays/oss-signal
|
|
8
|
-
- npm package: https://www.npmjs.com/package/oss-signal
|
|
9
|
-
- GitHub
|
|
8
|
+
- npm package: https://www.npmjs.com/package/oss-signal (`0.5.1` latest)
|
|
9
|
+
- GitHub Release: https://github.com/SalmonPlays/oss-signal/releases/tag/v0.5.1
|
|
10
|
+
- GitHub Action tag: https://github.com/SalmonPlays/oss-signal/tree/v0.5.1
|
|
10
11
|
- GitHub Action metadata: [action.yml](../action.yml)
|
|
11
12
|
- Public dogfood workflow: [.github/workflows/repository-health.yml](../.github/workflows/repository-health.yml)
|
|
13
|
+
- Separate public workflow demo: https://github.com/SalmonPlays/oss-signal-adoption-demo
|
|
14
|
+
- Separate public workflow run: https://github.com/SalmonPlays/oss-signal-adoption-demo/actions/runs/26862361229
|
|
12
15
|
- Self-audit report: [docs/self-audit.md](self-audit.md)
|
|
16
|
+
- SARIF self-audit output: [docs/examples/self-audit.sarif](examples/self-audit.sarif)
|
|
13
17
|
- GitHub URL audit report: [docs/examples/github-url-report.md](examples/github-url-report.md)
|
|
14
18
|
- GitHub Action workflow example: [docs/examples/github-action-workflow.yml](examples/github-action-workflow.yml)
|
|
19
|
+
- Maintainer playbook: [docs/maintainer-playbook.md](maintainer-playbook.md)
|
|
20
|
+
- Release process: [docs/release-process.md](release-process.md)
|
|
15
21
|
- Codex for Open Source application brief: [docs/codex-for-oss-application.md](codex-for-oss-application.md)
|
|
22
|
+
- Codex for Open Source form answers: [docs/codex-for-oss-form-answers.md](codex-for-oss-form-answers.md)
|
|
16
23
|
- Rule reference: [docs/rules.md](rules.md)
|
|
17
24
|
|
|
18
25
|
## Maintainer Use Case
|
|
@@ -24,7 +31,19 @@ The CLI supports two practical modes:
|
|
|
24
31
|
- Local repository audit for maintainers working in a clone.
|
|
25
32
|
- Public GitHub repository audit for quick triage without cloning.
|
|
26
33
|
|
|
27
|
-
It also ships as a GitHub Action, so maintainers can gate repository hygiene in CI, show the result in the GitHub Actions step summary,
|
|
34
|
+
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 workflow.
|
|
35
|
+
|
|
36
|
+
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.
|
|
37
|
+
|
|
38
|
+
## Separate Public Workflow Evidence
|
|
39
|
+
|
|
40
|
+
The public repository https://github.com/SalmonPlays/oss-signal-adoption-demo runs `SalmonPlays/oss-signal@v0.4.0` from a separate workflow file:
|
|
41
|
+
|
|
42
|
+
- Workflow file: https://github.com/SalmonPlays/oss-signal-adoption-demo/blob/main/.github/workflows/oss-signal.yml
|
|
43
|
+
- Successful workflow run: https://github.com/SalmonPlays/oss-signal-adoption-demo/actions/runs/26862361229
|
|
44
|
+
- Artifact: `oss-signal-adoption-demo-report`, containing `oss-signal-report.md` and `oss-signal.sarif`
|
|
45
|
+
|
|
46
|
+
This is not claimed as independent third-party adoption because the repository is owned by `SalmonPlays`. It is evidence that the public `v0.4.0` Action tag works outside the main repository and can publish maintainer-readiness reports from another public workflow.
|
|
28
47
|
|
|
29
48
|
## Public Field Audits And PRs
|
|
30
49
|
|
|
@@ -45,16 +64,19 @@ From this repository:
|
|
|
45
64
|
```bash
|
|
46
65
|
npm run check
|
|
47
66
|
npm run audit:github
|
|
67
|
+
node src/cli.js . --format sarif --output docs/examples/self-audit.sarif
|
|
48
68
|
node src/cli.js platformatic/massimo --format json
|
|
69
|
+
npm exec --yes --package=oss-signal@0.5.1 -- oss-signal SalmonPlays/oss-signal --format json
|
|
49
70
|
```
|
|
50
71
|
|
|
51
|
-
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.
|
|
72
|
+
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.5.1` Action tag is used by the repository health workflow for Markdown and SARIF output. The published npm `0.5.1` package has also been executed from a clean temporary directory against the public GitHub repository, returning 100/100 (A).
|
|
52
73
|
|
|
53
74
|
Public CI evidence:
|
|
54
75
|
|
|
55
76
|
- CI workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/ci.yml
|
|
56
77
|
- Repository health workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/repository-health.yml
|
|
57
78
|
- CodeQL workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/codeql.yml
|
|
79
|
+
- Separate workflow demo run: https://github.com/SalmonPlays/oss-signal-adoption-demo/actions/runs/26862361229
|
|
58
80
|
|
|
59
81
|
## Boundaries
|
|
60
82
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Codex for Open Source Application Brief
|
|
2
2
|
|
|
3
|
-
Snapshot: 2026-06-
|
|
3
|
+
Snapshot: 2026-06-03T05:11:50Z
|
|
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,11 +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
|
|
11
|
+
- GitHub Release: https://github.com/SalmonPlays/oss-signal/releases/tag/v0.5.1
|
|
12
|
+
- GitHub Action tag: https://github.com/SalmonPlays/oss-signal/tree/v0.5.1
|
|
12
13
|
- CI workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/ci.yml
|
|
13
14
|
- Repository health workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/repository-health.yml
|
|
14
15
|
- CodeQL workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/codeql.yml
|
|
16
|
+
- Separate public workflow demo: https://github.com/SalmonPlays/oss-signal-adoption-demo/actions/runs/26862361229
|
|
15
17
|
- Maintainer evidence: [adoption-evidence.md](adoption-evidence.md)
|
|
18
|
+
- Form answer pack: [codex-for-oss-form-answers.md](codex-for-oss-form-answers.md)
|
|
19
|
+
- Maintainer playbook: [maintainer-playbook.md](maintainer-playbook.md)
|
|
20
|
+
- Release process: [release-process.md](release-process.md)
|
|
16
21
|
|
|
17
22
|
## What `oss-signal` Does
|
|
18
23
|
|
|
@@ -22,7 +27,7 @@ This document summarizes why `oss-signal` is a fit for OpenAI's Codex for Open S
|
|
|
22
27
|
- CI, tests, issue templates, pull request templates, Dependabot, and CodeQL-style security workflow.
|
|
23
28
|
- Package metadata and lockfile hygiene.
|
|
24
29
|
|
|
25
|
-
The output is a deterministic score plus actionable next steps in Markdown or
|
|
30
|
+
The output is a deterministic score plus actionable next steps in Markdown, JSON, or SARIF. The GitHub Action also writes a workflow step summary so maintainers and reviewers can see the result without downloading an artifact.
|
|
26
31
|
|
|
27
32
|
## Why Codex Helps
|
|
28
33
|
|
|
@@ -31,6 +36,7 @@ This project is designed around repeatable maintainer workflows where Codex is u
|
|
|
31
36
|
- Run audits against public repositories without cloning.
|
|
32
37
|
- Convert findings into focused cleanup issues or pull requests.
|
|
33
38
|
- Keep repository hygiene visible in CI.
|
|
39
|
+
- Upload failed maintainer-readiness checks to GitHub Code Scanning through SARIF.
|
|
34
40
|
- Generate small contributor-facing files that maintainers can review quickly.
|
|
35
41
|
- Use Codex to turn audit findings into scoped documentation and workflow improvements.
|
|
36
42
|
|
|
@@ -38,14 +44,26 @@ This project is designed around repeatable maintainer workflows where Codex is u
|
|
|
38
44
|
|
|
39
45
|
The repository currently has:
|
|
40
46
|
|
|
41
|
-
- A published npm package.
|
|
47
|
+
- A published npm package with `0.5.1` as the latest release.
|
|
48
|
+
- A published GitHub Release for v0.5.1 with issue-output release notes and CI usage guidance.
|
|
42
49
|
- A reusable GitHub Action with `score`, `grade`, `failed`, and `report-path` outputs.
|
|
43
|
-
-
|
|
44
|
-
- A
|
|
50
|
+
- SARIF output for GitHub Code Scanning integration.
|
|
51
|
+
- A v0.5.1 GitHub Action tag with step summary, SARIF support, and Issue-ready output.
|
|
52
|
+
- A public dogfood workflow that runs `SalmonPlays/oss-signal@v0.5.1` against the repository, uploads the Markdown report artifact, and uploads SARIF to GitHub Code Scanning on non-PR runs.
|
|
53
|
+
- A separate public workflow demo that runs `SalmonPlays/oss-signal@v0.4.0` from another repository and uploads a report artifact.
|
|
54
|
+
- A maintainer playbook that documents audit, triage, issue, PR, CI, and SARIF workflows.
|
|
55
|
+
- A release process and tag-triggered release workflow that verify package contents and support npm provenance publishing when repository secrets are configured.
|
|
45
56
|
- CI and CodeQL workflows passing on `main`.
|
|
46
57
|
- A local self-audit score of 100/100.
|
|
58
|
+
- A clean-directory smoke test of `npm exec --yes --package=oss-signal@0.5.1 -- oss-signal SalmonPlays/oss-signal --format json`, returning 100/100 (A).
|
|
47
59
|
- Public reports, issues, and PRs created from real repository audits.
|
|
48
60
|
|
|
61
|
+
## Separate Workflow Demo
|
|
62
|
+
|
|
63
|
+
The repository https://github.com/SalmonPlays/oss-signal-adoption-demo runs the public `SalmonPlays/oss-signal@v0.4.0` Action tag from a separate workflow. The successful run at https://github.com/SalmonPlays/oss-signal-adoption-demo/actions/runs/26862361229 uploaded an `oss-signal-adoption-demo-report` artifact containing Markdown and SARIF output.
|
|
64
|
+
|
|
65
|
+
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.
|
|
66
|
+
|
|
49
67
|
## Field Audits And Follow-Up PRs
|
|
50
68
|
|
|
51
69
|
| Repository | Report | Issue | PR | Status |
|
|
@@ -62,15 +80,16 @@ Recommended application angle:
|
|
|
62
80
|
|
|
63
81
|
`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 three 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.
|
|
64
82
|
|
|
83
|
+
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.
|
|
84
|
+
|
|
65
85
|
## Current Gaps
|
|
66
86
|
|
|
67
87
|
- External PRs are open but not yet merged.
|
|
68
88
|
- npm download metrics are still early because the package is newly published.
|
|
69
|
-
- The project needs
|
|
89
|
+
- The project needs independent maintainer-owned repositories using the Action in their own workflows.
|
|
70
90
|
|
|
71
91
|
## Next Evidence To Collect
|
|
72
92
|
|
|
73
93
|
- One or more merged external PRs.
|
|
74
|
-
- A
|
|
75
|
-
- A public workflow run in another repository using `SalmonPlays/oss-signal@v0.3.0`.
|
|
94
|
+
- A public workflow run in an independent maintainer-owned repository using `SalmonPlays/oss-signal@v0.5.1`, ideally with SARIF upload enabled.
|
|
76
95
|
- npm download data once the registry starts reporting weekly/monthly counts.
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# Codex for Open Source Form Answers
|
|
2
|
+
|
|
3
|
+
Snapshot: 2026-06-03T05:11:50Z
|
|
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.5.1 and GitHub Action SalmonPlays/oss-signal@v0.5.1, supports Markdown/JSON/SARIF/Issue output, passes CI/CodeQL, and has public field-audit issues/PRs plus a separate workflow demo.
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Interest
|
|
57
|
+
|
|
58
|
+
```text
|
|
59
|
+
Codex Security
|
|
60
|
+
API credits for my project
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## OpenAI Organization ID
|
|
64
|
+
|
|
65
|
+
```text
|
|
66
|
+
Fill manually from https://platform.openai.com/settings/organization/general
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## API Credit Use
|
|
70
|
+
|
|
71
|
+
```text
|
|
72
|
+
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.
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Anything Else
|
|
76
|
+
|
|
77
|
+
```text
|
|
78
|
+
The project is early, so I am not overstating adoption. Current evidence includes npm 0.5.1, a published v0.5.1 release, a reusable GitHub Action, self-audit score 100/100, public CodeQL/CI, public field-audit PRs, and a separate public workflow run using SalmonPlays/oss-signal@v0.4.0 with a report artifact.
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Evidence Links
|
|
82
|
+
|
|
83
|
+
- npm package: https://www.npmjs.com/package/oss-signal
|
|
84
|
+
- GitHub Release v0.5.1: https://github.com/SalmonPlays/oss-signal/releases/tag/v0.5.1
|
|
85
|
+
- Main repository health workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/repository-health.yml
|
|
86
|
+
- Separate workflow demo repository: https://github.com/SalmonPlays/oss-signal-adoption-demo
|
|
87
|
+
- Separate successful workflow run: https://github.com/SalmonPlays/oss-signal-adoption-demo/actions/runs/26862361229
|
|
88
|
+
- Adoption evidence: https://github.com/SalmonPlays/oss-signal/blob/main/docs/adoption-evidence.md
|
|
89
|
+
|
|
90
|
+
## Character Counts
|
|
91
|
+
|
|
92
|
+
- Why this repository qualifies: 299/500
|
|
93
|
+
- API credit use: 312/500
|
|
94
|
+
- Anything else: 309/500
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
name: Repository health
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
pull_request:
|
|
5
|
+
push:
|
|
6
|
+
branches: [main]
|
|
7
|
+
workflow_dispatch:
|
|
8
|
+
|
|
9
|
+
permissions:
|
|
10
|
+
contents: read
|
|
11
|
+
security-events: write
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
oss-signal:
|
|
15
|
+
runs-on: ubuntu-latest
|
|
16
|
+
steps:
|
|
17
|
+
- uses: actions/checkout@v4
|
|
18
|
+
- uses: SalmonPlays/oss-signal@v0.5.1
|
|
19
|
+
id: oss-signal
|
|
20
|
+
with:
|
|
21
|
+
fail-under: "80"
|
|
22
|
+
output: oss-signal-report.md
|
|
23
|
+
summary: "true"
|
|
24
|
+
- uses: SalmonPlays/oss-signal@v0.5.1
|
|
25
|
+
with:
|
|
26
|
+
format: sarif
|
|
27
|
+
output: oss-signal.sarif
|
|
28
|
+
summary: "false"
|
|
29
|
+
- uses: github/codeql-action/upload-sarif@v3
|
|
30
|
+
if: github.event_name != 'pull_request'
|
|
31
|
+
with:
|
|
32
|
+
sarif_file: oss-signal.sarif
|
|
33
|
+
- uses: actions/upload-artifact@v4
|
|
34
|
+
with:
|
|
35
|
+
name: oss-signal-report
|
|
36
|
+
path: |
|
|
37
|
+
oss-signal-report.md
|
|
38
|
+
oss-signal.sarif
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Maintainer Readiness Follow-Up
|
|
2
|
+
|
|
3
|
+
oss-signal scored this repository **64/100 (D)**.
|
|
4
|
+
|
|
5
|
+
Source: GitHub (platformatic/massimo@main)
|
|
6
|
+
Generated: 2026-06-03T05:12:35.488Z
|
|
7
|
+
|
|
8
|
+
## Scope
|
|
9
|
+
|
|
10
|
+
This issue is limited to maintainer-readiness signals: documentation, contribution paths, CI, security reporting, and package hygiene. It does not claim there is a product-code bug.
|
|
11
|
+
|
|
12
|
+
## Suggested Next Steps
|
|
13
|
+
|
|
14
|
+
- [ ] **Security policy** (9 pts): Add SECURITY.md with supported versions, reporting instructions, and response expectations.
|
|
15
|
+
- [ ] **Changelog** (6 pts): Keep CHANGELOG.md with dated release entries and migration notes.
|
|
16
|
+
- [ ] **Issue templates** (5 pts): Add bug report and feature request templates under .github/ISSUE_TEMPLATE/.
|
|
17
|
+
- [ ] **Pull request template** (5 pts): Add .github/PULL_REQUEST_TEMPLATE.md with a short checklist.
|
|
18
|
+
- [ ] **Dependency update automation** (5 pts): Add .github/dependabot.yml for the package ecosystems used in the repository.
|
|
19
|
+
- [ ] **Support policy** (4 pts): Add SUPPORT.md describing where to ask questions, what is in scope, and expected response times.
|
|
20
|
+
- [ ] **Static security analysis** (4 pts): Add a CodeQL or equivalent security scanning workflow.
|
|
21
|
+
|
|
22
|
+
## Why These Checks Matter
|
|
23
|
+
|
|
24
|
+
- **Security policy**: Responsible disclosure needs a private, documented path.
|
|
25
|
+
- **Changelog**: Users need a durable place to understand release impact.
|
|
26
|
+
- **Issue templates**: Issue templates collect the facts maintainers need to reproduce and triage.
|
|
27
|
+
- **Pull request template**: PR templates nudge contributors to include tests, docs, and review context.
|
|
28
|
+
- **Dependency update automation**: Automated dependency updates reduce security and compatibility drift.
|
|
29
|
+
- **Support policy**: Support boundaries help maintainers avoid turning every request into unpaid consulting.
|
|
30
|
+
- **Static security analysis**: Static analysis finds common vulnerability patterns before releases.
|
|
31
|
+
|
|
32
|
+
## Notes For Maintainers
|
|
33
|
+
|
|
34
|
+
If any item is intentionally absent, documenting that decision is a valid outcome. Please close or edit this issue if it does not match the project's priorities.
|
|
35
|
+
|
|
36
|
+
_Generated by oss-signal; review before posting._
|
|
37
|
+
|