oss-signal 0.6.0 → 0.6.4
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 +15 -0
- package/README.md +21 -14
- package/action.yml +2 -2
- package/docs/adoption-evidence.md +16 -11
- package/docs/assets/github-social-preview.png +0 -0
- package/docs/assets/github-social-preview.svg +45 -0
- package/docs/assets/oss-signal-banner.svg +44 -0
- package/docs/assets/oss-signal-icon.png +0 -0
- package/docs/assets/oss-signal-icon.svg +27 -0
- package/docs/brand.md +43 -0
- package/docs/codex-for-oss-application.md +18 -14
- package/docs/codex-for-oss-form-answers.md +4 -4
- 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 +1 -1
- package/docs/examples/github-url-report.md +1 -1
- package/docs/examples/inventory-report.md +1 -1
- package/docs/examples/self-audit.sarif +2 -2
- package/docs/maintainer-playbook.md +4 -4
- package/docs/post-submission-update.md +68 -0
- package/docs/release-notes/v0.6.1.md +18 -0
- package/docs/release-notes/v0.6.2.md +17 -0
- package/docs/release-notes/v0.6.3.md +16 -0
- package/docs/release-notes/v0.6.4.md +17 -0
- package/docs/release-process.md +8 -8
- package/docs/reviewer-evidence.md +11 -5
- package/docs/self-audit.md +1 -1
- package/package.json +6 -2
- package/src/index.js +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
## Unreleased
|
|
4
4
|
|
|
5
|
+
## 0.6.3
|
|
6
|
+
|
|
7
|
+
- Updated the release workflow to use Node 24 and npm 11.16 for npm Trusted Publishing support.
|
|
8
|
+
- Published through GitHub Actions without an npm OTP.
|
|
9
|
+
|
|
10
|
+
## 0.6.2
|
|
11
|
+
|
|
12
|
+
- Switched the release workflow from token-gated publishing to npm Trusted Publishing with provenance.
|
|
13
|
+
- Removed the repository-variable gate so tag releases can publish through GitHub Actions OIDC without npm OTP.
|
|
14
|
+
|
|
15
|
+
## 0.6.1
|
|
16
|
+
|
|
17
|
+
- Added GitHub Release creation to the tag-triggered release workflow.
|
|
18
|
+
- Published the repository inventory release with a GitHub Release page and npm package verification path.
|
|
19
|
+
|
|
5
20
|
## 0.6.0
|
|
6
21
|
|
|
7
22
|
- Added repository inventory mode for auditing newline-delimited lists of local paths, GitHub URLs, and `owner/repo` shorthands.
|
package/README.md
CHANGED
|
@@ -1,24 +1,31 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="docs/assets/oss-signal-banner.svg" alt="OSS Maintainer Signal banner">
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
# OSS Maintainer Signal (`oss-signal`)
|
|
2
6
|
|
|
3
7
|
[](https://github.com/SalmonPlays/oss-signal/actions/workflows/ci.yml)
|
|
4
8
|
[](https://github.com/SalmonPlays/oss-signal/actions/workflows/repository-health.yml)
|
|
5
9
|
[](https://github.com/SalmonPlays/oss-signal/releases/latest)
|
|
6
10
|
[](https://www.npmjs.com/package/oss-signal)
|
|
7
11
|
[](https://www.npmjs.com/package/oss-signal)
|
|
12
|
+
[](docs/self-audit.md)
|
|
13
|
+
[](docs/reviewer-evidence.md)
|
|
8
14
|
[](LICENSE)
|
|
9
15
|
|
|
10
|
-
`oss-signal` is a dependency-light CLI for
|
|
16
|
+
`oss-signal` is a dependency-light maintainer-readiness CLI and GitHub Action for OSS projects that need repeatable triage, CI evidence, SARIF, inventory reports, and issue-ready cleanup notes.
|
|
11
17
|
|
|
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.
|
|
18
|
+
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, inventory, or a GitHub Issue-ready Markdown body.
|
|
13
19
|
|
|
14
20
|

|
|
15
21
|
|
|
16
22
|
## Maintainer Evidence Snapshot
|
|
17
23
|
|
|
18
|
-
Public evidence for the maintainer workflow is collected in [docs/reviewer-evidence.md](docs/reviewer-evidence.md)
|
|
24
|
+
Public evidence for the maintainer workflow is collected in [docs/reviewer-evidence.md](docs/reviewer-evidence.md), [docs/adoption-evidence.md](docs/adoption-evidence.md), [docs/post-submission-update.md](docs/post-submission-update.md), and [docs/brand.md](docs/brand.md).
|
|
19
25
|
|
|
20
|
-
- Published package: [`oss-signal@0.6.
|
|
21
|
-
- Published GitHub Action: [`SalmonPlays/oss-signal@v0.6.
|
|
26
|
+
- Published package: [`oss-signal@0.6.4`](https://www.npmjs.com/package/oss-signal), with `latest` pointing at `0.6.4`.
|
|
27
|
+
- Published GitHub Action: [`SalmonPlays/oss-signal@v0.6.4`](https://github.com/SalmonPlays/oss-signal/tree/v0.6.4).
|
|
28
|
+
- Post-submission version note: the application may reference earlier evidence; `0.6.4` is the current maintained release and is documented in [docs/post-submission-update.md](docs/post-submission-update.md).
|
|
22
29
|
- Public checks: CI, Repository health, and CodeQL are passing on `main`.
|
|
23
30
|
- Self-audit: this repository scores **100/100 (A)** locally and through GitHub URL mode.
|
|
24
31
|
- Field use: four public maintainer-readiness audits have been turned into four issues and four focused follow-up PRs.
|
|
@@ -142,7 +149,7 @@ Summary:
|
|
|
142
149
|
|
|
143
150
|
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.
|
|
144
151
|
|
|
145
|
-
The [Repository health workflow](.github/workflows/repository-health.yml) runs `SalmonPlays/oss-signal@v0.6.
|
|
152
|
+
The [Repository health workflow](.github/workflows/repository-health.yml) runs `SalmonPlays/oss-signal@v0.6.4`, 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.
|
|
146
153
|
|
|
147
154
|
## Field Audits
|
|
148
155
|
|
|
@@ -186,7 +193,7 @@ oss-signal . --fail-under 80
|
|
|
186
193
|
Add `oss-signal` directly to a GitHub Actions workflow:
|
|
187
194
|
|
|
188
195
|
```yaml
|
|
189
|
-
- uses: SalmonPlays/oss-signal@v0.6.
|
|
196
|
+
- uses: SalmonPlays/oss-signal@v0.6.4
|
|
190
197
|
id: oss-signal
|
|
191
198
|
with:
|
|
192
199
|
fail-under: "80"
|
|
@@ -202,7 +209,7 @@ The Action writes a concise GitHub Actions step summary by default, so reviewers
|
|
|
202
209
|
Run an inventory from CI:
|
|
203
210
|
|
|
204
211
|
```yaml
|
|
205
|
-
- uses: SalmonPlays/oss-signal@v0.6.
|
|
212
|
+
- uses: SalmonPlays/oss-signal@v0.6.4
|
|
206
213
|
env:
|
|
207
214
|
GITHUB_TOKEN: ${{ github.token }}
|
|
208
215
|
with:
|
|
@@ -214,7 +221,7 @@ Run an inventory from CI:
|
|
|
214
221
|
Generate an editable Issue body from CI:
|
|
215
222
|
|
|
216
223
|
```yaml
|
|
217
|
-
- uses: SalmonPlays/oss-signal@v0.6.
|
|
224
|
+
- uses: SalmonPlays/oss-signal@v0.6.4
|
|
218
225
|
with:
|
|
219
226
|
format: issue
|
|
220
227
|
output: maintainer-follow-up.md
|
|
@@ -236,7 +243,7 @@ jobs:
|
|
|
236
243
|
runs-on: ubuntu-latest
|
|
237
244
|
steps:
|
|
238
245
|
- uses: actions/checkout@v4
|
|
239
|
-
- uses: SalmonPlays/oss-signal@v0.6.
|
|
246
|
+
- uses: SalmonPlays/oss-signal@v0.6.4
|
|
240
247
|
id: oss-signal
|
|
241
248
|
with:
|
|
242
249
|
fail-under: "80"
|
|
@@ -259,7 +266,7 @@ permissions:
|
|
|
259
266
|
|
|
260
267
|
steps:
|
|
261
268
|
- uses: actions/checkout@v4
|
|
262
|
-
- uses: SalmonPlays/oss-signal@v0.6.
|
|
269
|
+
- uses: SalmonPlays/oss-signal@v0.6.4
|
|
263
270
|
with:
|
|
264
271
|
format: sarif
|
|
265
272
|
output: oss-signal.sarif
|
|
@@ -269,7 +276,7 @@ steps:
|
|
|
269
276
|
sarif_file: oss-signal.sarif
|
|
270
277
|
```
|
|
271
278
|
|
|
272
|
-
This repository dogfoods the public Action tag in [Repository health](.github/workflows/repository-health.yml), which runs `SalmonPlays/oss-signal@v0.6.
|
|
279
|
+
This repository dogfoods the public Action tag in [Repository health](.github/workflows/repository-health.yml), which runs `SalmonPlays/oss-signal@v0.6.4` against the repository, uploads the Markdown report artifact, and publishes SARIF to Code Scanning on non-PR runs.
|
|
273
280
|
|
|
274
281
|
You can also run the CLI directly in CI:
|
|
275
282
|
|
|
@@ -292,7 +299,7 @@ You can also run the CLI directly in CI:
|
|
|
292
299
|
|
|
293
300
|
## Release Process
|
|
294
301
|
|
|
295
|
-
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,
|
|
302
|
+
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, creates a GitHub Release, and publishes to npm with Trusted Publishing provenance.
|
|
296
303
|
|
|
297
304
|
## Contributing
|
|
298
305
|
|
package/action.yml
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
name: oss-signal
|
|
2
|
-
description: Audit
|
|
2
|
+
description: Audit OSS maintainer readiness and produce CI evidence, SARIF, inventory reports, and issue-ready cleanup notes.
|
|
3
3
|
author: SalmonPlays
|
|
4
4
|
branding:
|
|
5
|
-
icon:
|
|
5
|
+
icon: shield
|
|
6
6
|
color: blue
|
|
7
7
|
inputs:
|
|
8
8
|
path:
|
|
@@ -2,14 +2,14 @@
|
|
|
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-
|
|
5
|
+
Last verified: 2026-06-04T03:01:28Z
|
|
6
6
|
|
|
7
7
|
## Project Links
|
|
8
8
|
|
|
9
9
|
- Repository: https://github.com/SalmonPlays/oss-signal
|
|
10
|
-
- npm package: https://www.npmjs.com/package/oss-signal (`0.6.
|
|
11
|
-
- GitHub Release: https://github.com/SalmonPlays/oss-signal/releases/tag/v0.6.
|
|
12
|
-
- GitHub Action tag: https://github.com/SalmonPlays/oss-signal/tree/v0.6.
|
|
10
|
+
- npm package: https://www.npmjs.com/package/oss-signal (`0.6.4` latest)
|
|
11
|
+
- GitHub Release: https://github.com/SalmonPlays/oss-signal/releases/tag/v0.6.4
|
|
12
|
+
- GitHub Action tag: https://github.com/SalmonPlays/oss-signal/tree/v0.6.4
|
|
13
13
|
- GitHub Action metadata: [action.yml](../action.yml)
|
|
14
14
|
- Public dogfood workflow: [.github/workflows/repository-health.yml](../.github/workflows/repository-health.yml)
|
|
15
15
|
- Public inventory workflow: [.github/workflows/repository-inventory.yml](../.github/workflows/repository-inventory.yml)
|
|
@@ -21,8 +21,10 @@ Last verified: 2026-06-03T12:45:11Z
|
|
|
21
21
|
- GitHub Action workflow example: [docs/examples/github-action-workflow.yml](examples/github-action-workflow.yml)
|
|
22
22
|
- Inventory target example: [docs/examples/inventory-targets.txt](examples/inventory-targets.txt)
|
|
23
23
|
- Inventory report example: [docs/examples/inventory-report.md](examples/inventory-report.md)
|
|
24
|
+
- Brand assets and GitHub settings copy: [docs/brand.md](brand.md)
|
|
24
25
|
- Maintainer playbook: [docs/maintainer-playbook.md](maintainer-playbook.md)
|
|
25
26
|
- Reviewer evidence quickstart: [docs/reviewer-evidence.md](reviewer-evidence.md)
|
|
27
|
+
- Post-submission update: [docs/post-submission-update.md](post-submission-update.md)
|
|
26
28
|
- Release process: [docs/release-process.md](release-process.md)
|
|
27
29
|
- Codex for Open Source application brief: [docs/codex-for-oss-application.md](codex-for-oss-application.md)
|
|
28
30
|
- Codex for Open Source form answers: [docs/codex-for-oss-form-answers.md](codex-for-oss-form-answers.md)
|
|
@@ -42,17 +44,19 @@ It also ships as a GitHub Action, so maintainers can gate repository hygiene in
|
|
|
42
44
|
|
|
43
45
|
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.
|
|
44
46
|
|
|
47
|
+
The [post-submission update](post-submission-update.md) records why the current npm package and Action tag may be newer than the version referenced during application submission.
|
|
48
|
+
|
|
45
49
|
## Published Package Verification
|
|
46
50
|
|
|
47
|
-
The npm package is publicly available as `oss-signal@0.6.
|
|
51
|
+
The npm package is publicly available as `oss-signal@0.6.4` with `latest` pointing at `0.6.4`.
|
|
48
52
|
|
|
49
|
-
The npm downloads API returned 356 downloads for both last-week and last-month windows on 2026-06-
|
|
53
|
+
The npm downloads API returned 356 downloads for both last-week and last-month windows on 2026-06-04. Download counts can lag publication, so this is treated as supporting evidence rather than proof of broad adoption.
|
|
50
54
|
|
|
51
55
|
Clean-directory execution against the public GitHub repository returned:
|
|
52
56
|
|
|
53
57
|
```json
|
|
54
58
|
{
|
|
55
|
-
"version": "0.6.
|
|
59
|
+
"version": "0.6.4",
|
|
56
60
|
"score": 100,
|
|
57
61
|
"grade": "A",
|
|
58
62
|
"source": "github"
|
|
@@ -63,11 +67,12 @@ Current public workflow status:
|
|
|
63
67
|
|
|
64
68
|
- CI: passing
|
|
65
69
|
- Repository health: passing
|
|
70
|
+
- Repository inventory: passing
|
|
66
71
|
- CodeQL: passing
|
|
67
72
|
- Release: passing
|
|
68
73
|
- Separate public workflow demo: passing
|
|
69
74
|
|
|
70
|
-
The npm registry returned `0.6.
|
|
75
|
+
The npm registry returned `0.6.4` for both the package version and `latest` dist-tag on 2026-06-04T02:42:51Z. The same check returned 356 downloads for the last-week and last-month windows.
|
|
71
76
|
|
|
72
77
|
## Separate Public Workflow Evidence
|
|
73
78
|
|
|
@@ -92,7 +97,7 @@ The tool has been used to generate maintainer-readiness reports for public repos
|
|
|
92
97
|
|
|
93
98
|
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.
|
|
94
99
|
|
|
95
|
-
All four follow-up PRs were still open when checked from GitHub on 2026-06-
|
|
100
|
+
All four follow-up PRs were still open when checked from GitHub on 2026-06-04T02:42:51Z. They are not claimed as accepted adoption unless a maintainer merges or otherwise endorses them.
|
|
96
101
|
|
|
97
102
|
## Verification Commands
|
|
98
103
|
|
|
@@ -104,10 +109,10 @@ npm run audit:github
|
|
|
104
109
|
node src/cli.js . --format sarif --output docs/examples/self-audit.sarif
|
|
105
110
|
node src/cli.js --inventory docs/examples/inventory-targets.txt --format markdown --output docs/examples/inventory-report.md
|
|
106
111
|
node src/cli.js platformatic/massimo --format json
|
|
107
|
-
npm exec --yes --package=oss-signal@0.6.
|
|
112
|
+
npm exec --yes --package=oss-signal@0.6.4 -- oss-signal SalmonPlays/oss-signal --format json
|
|
108
113
|
```
|
|
109
114
|
|
|
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.
|
|
115
|
+
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.4` Action tag is used by the repository health workflow for Markdown and SARIF output. The published npm `0.6.4` package has also been executed from a clean temporary directory against the public GitHub repository, returning 100/100 (A).
|
|
111
116
|
|
|
112
117
|
Public CI evidence:
|
|
113
118
|
|
|
Binary file
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="1280" height="640" viewBox="0 0 1280 640" role="img" aria-labelledby="title desc">
|
|
2
|
+
<title id="title">OSS Maintainer Signal social preview</title>
|
|
3
|
+
<desc id="desc">Social preview image for the oss-signal repository.</desc>
|
|
4
|
+
<defs>
|
|
5
|
+
<linearGradient id="bg" x1="0" y1="0" x2="1280" y2="640" gradientUnits="userSpaceOnUse">
|
|
6
|
+
<stop offset="0" stop-color="#020617"/>
|
|
7
|
+
<stop offset="0.45" stop-color="#0f172a"/>
|
|
8
|
+
<stop offset="1" stop-color="#064e3b"/>
|
|
9
|
+
</linearGradient>
|
|
10
|
+
<linearGradient id="mark" x1="100" y1="95" x2="360" y2="360" gradientUnits="userSpaceOnUse">
|
|
11
|
+
<stop offset="0" stop-color="#38bdf8"/>
|
|
12
|
+
<stop offset="0.55" stop-color="#2563eb"/>
|
|
13
|
+
<stop offset="1" stop-color="#22c55e"/>
|
|
14
|
+
</linearGradient>
|
|
15
|
+
<filter id="shadow" x="-20%" y="-20%" width="140%" height="140%">
|
|
16
|
+
<feDropShadow dx="0" dy="22" stdDeviation="28" flood-color="#000000" flood-opacity="0.38"/>
|
|
17
|
+
</filter>
|
|
18
|
+
</defs>
|
|
19
|
+
<rect width="1280" height="640" fill="url(#bg)"/>
|
|
20
|
+
<circle cx="1080" cy="88" r="250" fill="#22c55e" opacity="0.12"/>
|
|
21
|
+
<circle cx="158" cy="562" r="270" fill="#38bdf8" opacity="0.14"/>
|
|
22
|
+
<path d="M80 526c240-185 478-239 713-161 177 58 314 29 420-83" fill="none" stroke="#93c5fd" stroke-width="2" opacity="0.18"/>
|
|
23
|
+
<g transform="translate(92 112)" filter="url(#shadow)">
|
|
24
|
+
<rect width="264" height="264" rx="60" fill="url(#mark)"/>
|
|
25
|
+
<path d="M132 42l83 31v69c0 52-33 91-83 110-50-19-83-58-83-110V73l83-31z" fill="#020617" opacity="0.3"/>
|
|
26
|
+
<circle cx="132" cy="146" r="53" fill="#f8fafc"/>
|
|
27
|
+
<path d="M105 146l20 20 42-49" fill="none" stroke="#16a34a" stroke-width="17" stroke-linecap="round" stroke-linejoin="round"/>
|
|
28
|
+
<path d="M81 92c28-25 74-25 102 0" fill="none" stroke="#e0f2fe" stroke-width="12" stroke-linecap="round" opacity="0.86"/>
|
|
29
|
+
</g>
|
|
30
|
+
<text x="410" y="160" fill="#93c5fd" font-family="-apple-system, BlinkMacSystemFont, Segoe UI, sans-serif" font-size="28" font-weight="800" letter-spacing="4">OSS-SIGNAL</text>
|
|
31
|
+
<text x="410" y="238" fill="#f8fafc" font-family="-apple-system, BlinkMacSystemFont, Segoe UI, sans-serif" font-size="70" font-weight="850">OSS Maintainer Signal</text>
|
|
32
|
+
<text x="414" y="300" fill="#cbd5e1" font-family="-apple-system, BlinkMacSystemFont, Segoe UI, sans-serif" font-size="31">A maintainer-readiness CLI and GitHub Action for OSS cleanup.</text>
|
|
33
|
+
<g font-family="-apple-system, BlinkMacSystemFont, Segoe UI, sans-serif" font-size="24" font-weight="800">
|
|
34
|
+
<rect x="414" y="366" width="176" height="56" rx="28" fill="#dcfce7"/>
|
|
35
|
+
<text x="448" y="402" fill="#166534">100/100 A</text>
|
|
36
|
+
<rect x="612" y="366" width="178" height="56" rx="28" fill="#dbeafe"/>
|
|
37
|
+
<text x="646" y="402" fill="#1e40af">npm latest</text>
|
|
38
|
+
<rect x="812" y="366" width="246" height="56" rx="28" fill="#e0f2fe"/>
|
|
39
|
+
<text x="851" y="402" fill="#075985">SARIF + Issues</text>
|
|
40
|
+
</g>
|
|
41
|
+
<g transform="translate(414 478)" font-family="ui-monospace, SFMono-Regular, Menlo, Consolas, monospace" font-size="23">
|
|
42
|
+
<text x="0" y="0" fill="#22c55e">$ npx oss-signal SalmonPlays/oss-signal</text>
|
|
43
|
+
<text x="0" y="44" fill="#e2e8f0">score: 100/100 grade: A source: github</text>
|
|
44
|
+
</g>
|
|
45
|
+
</svg>
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="1280" height="420" viewBox="0 0 1280 420" role="img" aria-labelledby="title desc">
|
|
2
|
+
<title id="title">OSS Maintainer Signal banner</title>
|
|
3
|
+
<desc id="desc">A banner for oss-signal describing an OSS maintainer-readiness CLI and GitHub Action.</desc>
|
|
4
|
+
<defs>
|
|
5
|
+
<linearGradient id="bg" x1="0" y1="0" x2="1280" y2="420" gradientUnits="userSpaceOnUse">
|
|
6
|
+
<stop offset="0" stop-color="#020617"/>
|
|
7
|
+
<stop offset="0.52" stop-color="#0f172a"/>
|
|
8
|
+
<stop offset="1" stop-color="#052e16"/>
|
|
9
|
+
</linearGradient>
|
|
10
|
+
<linearGradient id="accent" x1="170" y1="42" x2="1080" y2="360" gradientUnits="userSpaceOnUse">
|
|
11
|
+
<stop offset="0" stop-color="#38bdf8"/>
|
|
12
|
+
<stop offset="0.55" stop-color="#2563eb"/>
|
|
13
|
+
<stop offset="1" stop-color="#22c55e"/>
|
|
14
|
+
</linearGradient>
|
|
15
|
+
<filter id="softShadow" x="-20%" y="-20%" width="140%" height="140%">
|
|
16
|
+
<feDropShadow dx="0" dy="20" stdDeviation="22" flood-color="#000000" flood-opacity="0.35"/>
|
|
17
|
+
</filter>
|
|
18
|
+
</defs>
|
|
19
|
+
<rect width="1280" height="420" fill="url(#bg)"/>
|
|
20
|
+
<circle cx="1052" cy="92" r="180" fill="#22c55e" opacity="0.13"/>
|
|
21
|
+
<circle cx="115" cy="365" r="220" fill="#0ea5e9" opacity="0.16"/>
|
|
22
|
+
<path d="M102 344c245-176 464-222 657-139 149 64 276 54 419-32" fill="none" stroke="#38bdf8" stroke-width="2" opacity="0.18"/>
|
|
23
|
+
<g transform="translate(88 76)" filter="url(#softShadow)">
|
|
24
|
+
<rect width="196" height="196" rx="44" fill="url(#accent)"/>
|
|
25
|
+
<path d="M98 33l62 23v51c0 39-25 68-62 82-37-14-62-43-62-82V56l62-23z" fill="#020617" opacity="0.3"/>
|
|
26
|
+
<circle cx="98" cy="108" r="39" fill="#f8fafc"/>
|
|
27
|
+
<path d="M78 108l15 15 31-36" fill="none" stroke="#16a34a" stroke-width="13" stroke-linecap="round" stroke-linejoin="round"/>
|
|
28
|
+
<path d="M60 68c21-19 55-19 76 0" fill="none" stroke="#e0f2fe" stroke-width="9" stroke-linecap="round" opacity="0.85"/>
|
|
29
|
+
</g>
|
|
30
|
+
<text x="332" y="116" fill="#93c5fd" font-family="-apple-system, BlinkMacSystemFont, Segoe UI, sans-serif" font-size="24" font-weight="700" letter-spacing="3">OSS-SIGNAL</text>
|
|
31
|
+
<text x="332" y="176" fill="#f8fafc" font-family="-apple-system, BlinkMacSystemFont, Segoe UI, sans-serif" font-size="58" font-weight="800">OSS Maintainer Signal</text>
|
|
32
|
+
<text x="334" y="222" fill="#cbd5e1" font-family="-apple-system, BlinkMacSystemFont, Segoe UI, sans-serif" font-size="26">Audit maintainer readiness, then turn findings into CI gates, SARIF, issues, and PRs.</text>
|
|
33
|
+
<g font-family="-apple-system, BlinkMacSystemFont, Segoe UI, sans-serif" font-size="18" font-weight="700">
|
|
34
|
+
<rect x="334" y="266" width="144" height="42" rx="21" fill="#dcfce7"/>
|
|
35
|
+
<text x="359" y="293" fill="#166534">100/100 A</text>
|
|
36
|
+
<rect x="494" y="266" width="142" height="42" rx="21" fill="#dbeafe"/>
|
|
37
|
+
<text x="521" y="293" fill="#1e40af">npm 0.6.4</text>
|
|
38
|
+
<rect x="652" y="266" width="178" height="42" rx="21" fill="#e0f2fe"/>
|
|
39
|
+
<text x="681" y="293" fill="#075985">GitHub Action</text>
|
|
40
|
+
<rect x="846" y="266" width="168" height="42" rx="21" fill="#fef9c3"/>
|
|
41
|
+
<text x="876" y="293" fill="#854d0e">Inventory mode</text>
|
|
42
|
+
</g>
|
|
43
|
+
<text x="335" y="356" fill="#64748b" font-family="ui-monospace, SFMono-Regular, Menlo, Consolas, monospace" font-size="22">$ npx oss-signal SalmonPlays/oss-signal</text>
|
|
44
|
+
</svg>
|
|
Binary file
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="512" height="512" viewBox="0 0 512 512" role="img" aria-labelledby="title desc">
|
|
2
|
+
<title id="title">OSS Maintainer Signal icon</title>
|
|
3
|
+
<desc id="desc">A shield-shaped signal mark with a check in the center, representing maintainer-readiness verification.</desc>
|
|
4
|
+
<defs>
|
|
5
|
+
<linearGradient id="bg" x1="72" y1="60" x2="444" y2="452" gradientUnits="userSpaceOnUse">
|
|
6
|
+
<stop offset="0" stop-color="#0ea5e9"/>
|
|
7
|
+
<stop offset="0.48" stop-color="#2563eb"/>
|
|
8
|
+
<stop offset="1" stop-color="#16a34a"/>
|
|
9
|
+
</linearGradient>
|
|
10
|
+
<linearGradient id="glow" x1="120" y1="80" x2="420" y2="420" gradientUnits="userSpaceOnUse">
|
|
11
|
+
<stop offset="0" stop-color="#ffffff" stop-opacity="0.85"/>
|
|
12
|
+
<stop offset="1" stop-color="#ffffff" stop-opacity="0.2"/>
|
|
13
|
+
</linearGradient>
|
|
14
|
+
<filter id="shadow" x="-20%" y="-20%" width="140%" height="140%">
|
|
15
|
+
<feDropShadow dx="0" dy="18" stdDeviation="20" flood-color="#020617" flood-opacity="0.32"/>
|
|
16
|
+
</filter>
|
|
17
|
+
</defs>
|
|
18
|
+
<rect width="512" height="512" rx="112" fill="#020617"/>
|
|
19
|
+
<circle cx="406" cy="116" r="82" fill="#22c55e" opacity="0.18"/>
|
|
20
|
+
<circle cx="120" cy="384" r="96" fill="#38bdf8" opacity="0.16"/>
|
|
21
|
+
<path d="M256 62l156 58v126c0 98-62 170-156 204-94-34-156-106-156-204V120l156-58z" fill="url(#bg)" filter="url(#shadow)"/>
|
|
22
|
+
<path d="M256 96l122 46v102c0 74-45 133-122 164-77-31-122-90-122-164V142l122-46z" fill="#08111f" opacity="0.26"/>
|
|
23
|
+
<path d="M171 263c0-47 38-85 85-85s85 38 85 85-38 85-85 85-85-38-85-85z" fill="#f8fafc"/>
|
|
24
|
+
<path d="M215 263l31 31 62-72" fill="none" stroke="#16a34a" stroke-width="28" stroke-linecap="round" stroke-linejoin="round"/>
|
|
25
|
+
<path d="M178 162c22-20 49-31 78-31s56 11 78 31" fill="none" stroke="#dbeafe" stroke-width="20" stroke-linecap="round" opacity="0.9"/>
|
|
26
|
+
<path d="M143 126c31-32 71-50 113-50s82 18 113 50" fill="none" stroke="url(#glow)" stroke-width="18" stroke-linecap="round" opacity="0.55"/>
|
|
27
|
+
</svg>
|
package/docs/brand.md
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Brand Assets
|
|
2
|
+
|
|
3
|
+
Display name: **OSS Maintainer Signal**
|
|
4
|
+
|
|
5
|
+
Package, CLI, and GitHub Action name: `oss-signal`
|
|
6
|
+
|
|
7
|
+
The display name is intentionally more descriptive for reviewers, while `oss-signal` stays stable for npm, GitHub Action tags, existing links, and the submitted application evidence.
|
|
8
|
+
|
|
9
|
+
## Assets
|
|
10
|
+
|
|
11
|
+
- Icon: [assets/oss-signal-icon.svg](assets/oss-signal-icon.svg)
|
|
12
|
+
- Icon PNG: [assets/oss-signal-icon.png](assets/oss-signal-icon.png)
|
|
13
|
+
- README banner: [assets/oss-signal-banner.svg](assets/oss-signal-banner.svg)
|
|
14
|
+
- GitHub social preview source: [assets/github-social-preview.svg](assets/github-social-preview.svg)
|
|
15
|
+
- GitHub social preview PNG: [assets/github-social-preview.png](assets/github-social-preview.png)
|
|
16
|
+
|
|
17
|
+
## GitHub Settings Copy
|
|
18
|
+
|
|
19
|
+
Recommended repository description:
|
|
20
|
+
|
|
21
|
+
> Maintainer-readiness CLI and GitHub Action for OSS triage, CI evidence, inventory reports, SARIF, and issue-ready cleanup.
|
|
22
|
+
|
|
23
|
+
Recommended repository topics:
|
|
24
|
+
|
|
25
|
+
```text
|
|
26
|
+
open-source
|
|
27
|
+
maintainer-tools
|
|
28
|
+
github-action
|
|
29
|
+
cli
|
|
30
|
+
repository-health
|
|
31
|
+
sarif
|
|
32
|
+
triage
|
|
33
|
+
oss
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Manual UI Settings
|
|
37
|
+
|
|
38
|
+
These cannot be committed through git:
|
|
39
|
+
|
|
40
|
+
- Repository social preview: upload `docs/assets/github-social-preview.png` in GitHub repository settings.
|
|
41
|
+
- GitHub profile or organization avatar: upload `docs/assets/oss-signal-icon.png`.
|
|
42
|
+
|
|
43
|
+
The repository name should remain `oss-signal` unless the npm package and GitHub Action distribution are intentionally migrated.
|
|
@@ -1,15 +1,16 @@
|
|
|
1
1
|
# Codex for Open Source Application Brief
|
|
2
2
|
|
|
3
|
-
Snapshot: 2026-06-
|
|
3
|
+
Snapshot: 2026-06-04T02:42:51Z
|
|
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
|
|
|
7
7
|
## Project
|
|
8
8
|
|
|
9
|
+
- Display name: OSS Maintainer Signal
|
|
9
10
|
- Repository: https://github.com/SalmonPlays/oss-signal
|
|
10
11
|
- npm package: https://www.npmjs.com/package/oss-signal
|
|
11
|
-
- GitHub Release: https://github.com/SalmonPlays/oss-signal/releases/tag/v0.6.
|
|
12
|
-
- GitHub Action tag: https://github.com/SalmonPlays/oss-signal/tree/v0.6.
|
|
12
|
+
- GitHub Release: https://github.com/SalmonPlays/oss-signal/releases/tag/v0.6.4
|
|
13
|
+
- GitHub Action tag: https://github.com/SalmonPlays/oss-signal/tree/v0.6.4
|
|
13
14
|
- CI workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/ci.yml
|
|
14
15
|
- Repository health workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/repository-health.yml
|
|
15
16
|
- Repository inventory workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/repository-inventory.yml
|
|
@@ -17,13 +18,15 @@ This document summarizes why `oss-signal` is a fit for OpenAI's Codex for Open S
|
|
|
17
18
|
- Separate public workflow demo: https://github.com/SalmonPlays/oss-signal-adoption-demo/actions/runs/26883001038
|
|
18
19
|
- Maintainer evidence: [adoption-evidence.md](adoption-evidence.md)
|
|
19
20
|
- Reviewer evidence quickstart: [reviewer-evidence.md](reviewer-evidence.md)
|
|
21
|
+
- Post-submission update: [post-submission-update.md](post-submission-update.md)
|
|
22
|
+
- Brand assets and GitHub settings copy: [brand.md](brand.md)
|
|
20
23
|
- Form answer pack: [codex-for-oss-form-answers.md](codex-for-oss-form-answers.md)
|
|
21
24
|
- Maintainer playbook: [maintainer-playbook.md](maintainer-playbook.md)
|
|
22
25
|
- Release process: [release-process.md](release-process.md)
|
|
23
26
|
|
|
24
27
|
## What `oss-signal` Does
|
|
25
28
|
|
|
26
|
-
`oss-signal
|
|
29
|
+
`oss-signal`, presented as OSS Maintainer Signal, is a dependency-light CLI and GitHub Action for OSS maintainers. It audits maintainer-readiness signals that lower recurring maintainer load:
|
|
27
30
|
|
|
28
31
|
- README, license, contribution, support, security, code of conduct, and changelog files.
|
|
29
32
|
- CI, tests, issue templates, pull request templates, Dependabot, and CodeQL-style security workflow.
|
|
@@ -47,22 +50,23 @@ This project is designed around repeatable maintainer workflows where Codex is u
|
|
|
47
50
|
|
|
48
51
|
The repository currently has:
|
|
49
52
|
|
|
50
|
-
- A published npm package with `0.6.
|
|
51
|
-
-
|
|
52
|
-
-
|
|
53
|
+
- A published npm package with `0.6.4` as the latest release.
|
|
54
|
+
- A post-submission update page explaining why the current npm package and Action tag may be newer than the originally submitted evidence.
|
|
55
|
+
- npm download API evidence showing 356 last-week and last-month downloads on 2026-06-04.
|
|
56
|
+
- A published GitHub Release for v0.6.4 with repository inventory release notes and CI usage guidance.
|
|
53
57
|
- A reusable GitHub Action with `score`, `grade`, `failed`, and `report-path` outputs.
|
|
54
58
|
- 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.
|
|
59
|
+
- A clean npm smoke test of `oss-signal@0.6.4` returning version `0.6.4`, score `100`, grade `A`, and source `github`.
|
|
56
60
|
- SARIF output for GitHub Code Scanning integration.
|
|
57
|
-
- A v0.6.
|
|
58
|
-
- A public dogfood workflow that runs `SalmonPlays/oss-signal@v0.6.
|
|
59
|
-
- A public dogfood inventory workflow that runs `SalmonPlays/oss-signal@v0.6.
|
|
61
|
+
- A v0.6.4 GitHub Action tag with step summary, SARIF support, inventory support, and Issue-ready output.
|
|
62
|
+
- A public dogfood workflow that runs `SalmonPlays/oss-signal@v0.6.4` against the repository, uploads the Markdown report artifact, and uploads SARIF to GitHub Code Scanning on non-PR runs.
|
|
63
|
+
- A public dogfood inventory workflow that runs `SalmonPlays/oss-signal@v0.6.4` against a repository target list and uploads an inventory artifact.
|
|
60
64
|
- 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.
|
|
61
65
|
- A maintainer playbook that documents audit, triage, issue, PR, CI, and SARIF workflows.
|
|
62
|
-
- A release process and tag-triggered release workflow that verify package contents and
|
|
66
|
+
- A release process and tag-triggered release workflow that verify package contents and publish to npm through Trusted Publishing.
|
|
63
67
|
- CI, Repository health, CodeQL, and Release workflows passing publicly.
|
|
64
68
|
- A local self-audit score of 100/100.
|
|
65
|
-
- A clean-directory smoke test of `npm exec --yes --package=oss-signal@0.6.
|
|
69
|
+
- A clean-directory smoke test of `npm exec --yes --package=oss-signal@0.6.4 -- oss-signal SalmonPlays/oss-signal --format json`, returning 100/100 (A).
|
|
66
70
|
- Public reports, issues, and PRs created from real repository audits, including four posted field-audit issues and four follow-up PRs.
|
|
67
71
|
|
|
68
72
|
## Separate Workflow Demo
|
|
@@ -99,5 +103,5 @@ Prepared official form answers are in [codex-for-oss-form-answers.md](codex-for-
|
|
|
99
103
|
## Next Evidence To Collect
|
|
100
104
|
|
|
101
105
|
- One or more merged external PRs.
|
|
102
|
-
- A public workflow run in an independent maintainer-owned repository using `SalmonPlays/oss-signal@v0.6.
|
|
106
|
+
- A public workflow run in an independent maintainer-owned repository using `SalmonPlays/oss-signal@v0.6.4`, ideally with SARIF or inventory upload enabled.
|
|
103
107
|
- npm download data once the registry starts reporting weekly/monthly counts.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Codex for Open Source Form Answers
|
|
2
2
|
|
|
3
|
-
Snapshot: 2026-06-
|
|
3
|
+
Snapshot: 2026-06-04T02:42:51Z
|
|
4
4
|
|
|
5
5
|
This page prepares concise answers for the official Codex for Open Source application form: https://openai.com/form/codex-for-oss/
|
|
6
6
|
|
|
@@ -50,7 +50,7 @@ Primary maintainer
|
|
|
50
50
|
## Why This Repository Qualifies
|
|
51
51
|
|
|
52
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.
|
|
53
|
+
oss-signal is a public OSS maintainer tool for reducing triage and review load. It ships as npm package oss-signal@0.6.4 and GitHub Action SalmonPlays/oss-signal@v0.6.4, 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
54
|
```
|
|
55
55
|
|
|
56
56
|
## Interest
|
|
@@ -81,13 +81,13 @@ Use Codex/API credits to run repeatable public repository audits, draft focused
|
|
|
81
81
|
## Anything Else
|
|
82
82
|
|
|
83
83
|
```text
|
|
84
|
-
The project is early, so I am not overstating adoption. Current evidence includes npm 0.6.
|
|
84
|
+
The project is early, so I am not overstating adoption. Current evidence includes npm 0.6.4 latest, 356 npm downloads reported by the registry API, a published v0.6.4 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
85
|
```
|
|
86
86
|
|
|
87
87
|
## Evidence Links
|
|
88
88
|
|
|
89
89
|
- npm package: https://www.npmjs.com/package/oss-signal
|
|
90
|
-
- GitHub Release v0.6.
|
|
90
|
+
- GitHub Release v0.6.4: https://github.com/SalmonPlays/oss-signal/releases/tag/v0.6.4
|
|
91
91
|
- Main repository health workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/repository-health.yml
|
|
92
92
|
- Separate workflow demo repository: https://github.com/SalmonPlays/oss-signal-adoption-demo
|
|
93
93
|
- Separate successful workflow run: https://github.com/SalmonPlays/oss-signal-adoption-demo/actions/runs/26883001038
|
|
@@ -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.6.
|
|
18
|
+
- uses: SalmonPlays/oss-signal@v0.6.4
|
|
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.6.
|
|
24
|
+
- uses: SalmonPlays/oss-signal@v0.6.4
|
|
25
25
|
with:
|
|
26
26
|
format: sarif
|
|
27
27
|
output: oss-signal.sarif
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
"tool": {
|
|
7
7
|
"driver": {
|
|
8
8
|
"name": "oss-signal",
|
|
9
|
-
"semanticVersion": "0.6.
|
|
9
|
+
"semanticVersion": "0.6.4",
|
|
10
10
|
"informationUri": "https://github.com/SalmonPlays/oss-signal",
|
|
11
11
|
"rules": [
|
|
12
12
|
{
|
|
@@ -400,7 +400,7 @@
|
|
|
400
400
|
"score": 100,
|
|
401
401
|
"grade": "A",
|
|
402
402
|
"source": "local",
|
|
403
|
-
"generatedAt": "2026-06-
|
|
403
|
+
"generatedAt": "2026-06-04T03:22:19.351Z"
|
|
404
404
|
}
|
|
405
405
|
}
|
|
406
406
|
]
|
|
@@ -71,7 +71,7 @@ The field-audit examples in [docs/outreach](outreach) show this pattern for publ
|
|
|
71
71
|
Add the GitHub Action to keep the signal visible:
|
|
72
72
|
|
|
73
73
|
```yaml
|
|
74
|
-
- uses: SalmonPlays/oss-signal@v0.6.
|
|
74
|
+
- uses: SalmonPlays/oss-signal@v0.6.4
|
|
75
75
|
id: oss-signal
|
|
76
76
|
with:
|
|
77
77
|
fail-under: "80"
|
|
@@ -84,7 +84,7 @@ The Action writes `score`, `grade`, `failed`, and `report-path` outputs, and wri
|
|
|
84
84
|
For a repository inventory, commit a newline-delimited target list and pass it through the Action:
|
|
85
85
|
|
|
86
86
|
```yaml
|
|
87
|
-
- uses: SalmonPlays/oss-signal@v0.6.
|
|
87
|
+
- uses: SalmonPlays/oss-signal@v0.6.4
|
|
88
88
|
env:
|
|
89
89
|
GITHUB_TOKEN: ${{ github.token }}
|
|
90
90
|
with:
|
|
@@ -104,7 +104,7 @@ permissions:
|
|
|
104
104
|
|
|
105
105
|
steps:
|
|
106
106
|
- uses: actions/checkout@v4
|
|
107
|
-
- uses: SalmonPlays/oss-signal@v0.6.
|
|
107
|
+
- uses: SalmonPlays/oss-signal@v0.6.4
|
|
108
108
|
with:
|
|
109
109
|
format: sarif
|
|
110
110
|
output: oss-signal.sarif
|
|
@@ -120,7 +120,7 @@ See [docs/examples/github-code-scanning-workflow.yml](examples/github-code-scann
|
|
|
120
120
|
|
|
121
121
|
Useful evidence for maintainers and reviewers:
|
|
122
122
|
|
|
123
|
-
- A public workflow run that uses `SalmonPlays/oss-signal@v0.6.
|
|
123
|
+
- A public workflow run that uses `SalmonPlays/oss-signal@v0.6.4`.
|
|
124
124
|
- A generated Markdown report attached as an artifact.
|
|
125
125
|
- A SARIF upload in Code Scanning.
|
|
126
126
|
- A small issue or PR that follows from an audit finding.
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# Post-Submission Update
|
|
2
|
+
|
|
3
|
+
Application submitted: 2026-06-03
|
|
4
|
+
|
|
5
|
+
Latest verification: 2026-06-04T03:01:28Z
|
|
6
|
+
|
|
7
|
+
This page explains why the version referenced during the Codex for Open Source application review may be older than the current npm package and GitHub Action tag.
|
|
8
|
+
|
|
9
|
+
## Why The Version Changed
|
|
10
|
+
|
|
11
|
+
The application points reviewers to the public repository and package evidence. After submission, `oss-signal` continued normal OSS maintenance and shipped additional public releases.
|
|
12
|
+
|
|
13
|
+
The older submission evidence remains valid. The current `latest` npm version simply supersedes it with a stronger release and automation story.
|
|
14
|
+
|
|
15
|
+
## Release Timeline
|
|
16
|
+
|
|
17
|
+
| Version | Public evidence | What changed |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| `v0.6.0` | npm package and tag | Added repository inventory mode for auditing lists of repositories. |
|
|
20
|
+
| `v0.6.1` | GitHub Release | Added tag-triggered release automation. |
|
|
21
|
+
| `v0.6.2` | GitHub Release | Registered npm Trusted Publishing release flow. |
|
|
22
|
+
| `v0.6.3` | npm package, GitHub Release, Action tag | Completed npm Trusted Publishing from GitHub Actions without manual OTP. |
|
|
23
|
+
| `v0.6.4` | npm package, GitHub Release, Action tag | Published OSS Maintainer Signal brand assets and npm/GitHub metadata polish. |
|
|
24
|
+
|
|
25
|
+
## Current Evidence
|
|
26
|
+
|
|
27
|
+
- npm package: https://www.npmjs.com/package/oss-signal (`0.6.4` latest)
|
|
28
|
+
- GitHub Release: https://github.com/SalmonPlays/oss-signal/releases/tag/v0.6.4
|
|
29
|
+
- GitHub Action tag: https://github.com/SalmonPlays/oss-signal/tree/v0.6.4
|
|
30
|
+
- Release workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/release.yml
|
|
31
|
+
- Repository health workflow: https://github.com/SalmonPlays/oss-signal/actions/workflows/repository-health.yml
|
|
32
|
+
- Reviewer evidence quickstart: [reviewer-evidence.md](reviewer-evidence.md)
|
|
33
|
+
- Adoption evidence: [adoption-evidence.md](adoption-evidence.md)
|
|
34
|
+
|
|
35
|
+
## Clean Verification
|
|
36
|
+
|
|
37
|
+
The public registry returned `0.6.4` for both package version and `latest` dist-tag after the brand refresh release on 2026-06-04.
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npm view oss-signal version dist-tags --json
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Expected result:
|
|
44
|
+
|
|
45
|
+
```json
|
|
46
|
+
{
|
|
47
|
+
"version": "0.6.4",
|
|
48
|
+
"dist-tags": {
|
|
49
|
+
"latest": "0.6.4"
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
A clean npm execution against the public GitHub repository returned version `0.6.4`, score `100`, grade `A`, and source `github`.
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
npm exec --yes --package=oss-signal@0.6.4 -- oss-signal SalmonPlays/oss-signal --format json
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Review Impact
|
|
61
|
+
|
|
62
|
+
This version difference should be read as post-submission maintenance progress, not as a mismatch. It strengthens the evidence in three ways:
|
|
63
|
+
|
|
64
|
+
- The package now has a successful npm Trusted Publishing release from GitHub Actions.
|
|
65
|
+
- The GitHub Action tag, npm package, release notes, and documentation all point to `0.6.4`.
|
|
66
|
+
- The repository has public CI, Repository health, Repository inventory, CodeQL, and Release workflow evidence.
|
|
67
|
+
|
|
68
|
+
This does not replace the remaining adoption gap. The strongest next evidence would still be independent maintainer-owned workflow usage or merged external maintainer PRs.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# oss-signal v0.6.1
|
|
2
|
+
|
|
3
|
+
`oss-signal` v0.6.1 publishes the repository inventory release with GitHub Release automation enabled.
|
|
4
|
+
|
|
5
|
+
## Highlights
|
|
6
|
+
|
|
7
|
+
- Keeps the v0.6 inventory mode for auditing newline-delimited lists of repositories.
|
|
8
|
+
- Keeps GitHub Action inventory support with step summary output and average-score outputs.
|
|
9
|
+
- Adds release workflow automation that creates a GitHub Release from `docs/release-notes/`.
|
|
10
|
+
- Verifies npm package contents before release publication.
|
|
11
|
+
|
|
12
|
+
## Verification
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm run check
|
|
16
|
+
node src/cli.js --inventory docs/examples/inventory-targets.txt --format markdown
|
|
17
|
+
npm publish --dry-run
|
|
18
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# oss-signal v0.6.2
|
|
2
|
+
|
|
3
|
+
`oss-signal` v0.6.2 switches release publishing to npm Trusted Publishing.
|
|
4
|
+
|
|
5
|
+
## Highlights
|
|
6
|
+
|
|
7
|
+
- Publishes from GitHub Actions through npm Trusted Publishing and OIDC.
|
|
8
|
+
- Keeps npm provenance enabled with `npm publish --provenance`.
|
|
9
|
+
- Removes the old `NPM_TOKEN` / `NPM_PUBLISH_ENABLED` gate from release publishing.
|
|
10
|
+
- Keeps the v0.6 repository inventory CLI and GitHub Action support.
|
|
11
|
+
|
|
12
|
+
## Verification
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm run check
|
|
16
|
+
npm publish --dry-run
|
|
17
|
+
```
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# oss-signal v0.6.3
|
|
2
|
+
|
|
3
|
+
`oss-signal` v0.6.3 completes the move to npm Trusted Publishing.
|
|
4
|
+
|
|
5
|
+
## Highlights
|
|
6
|
+
|
|
7
|
+
- Uses Node 24 and npm 11.16 in the release workflow for Trusted Publishing support.
|
|
8
|
+
- Publishes from GitHub Actions without a manual npm OTP.
|
|
9
|
+
- Keeps GitHub Release creation, package verification, and the v0.6 repository inventory workflow.
|
|
10
|
+
|
|
11
|
+
## Verification
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm run check
|
|
15
|
+
npm publish --dry-run
|
|
16
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# oss-signal v0.6.4
|
|
2
|
+
|
|
3
|
+
`oss-signal` v0.6.4 publishes the OSS Maintainer Signal brand refresh.
|
|
4
|
+
|
|
5
|
+
## Changes
|
|
6
|
+
|
|
7
|
+
- Adds a README banner, icon, and GitHub social preview assets.
|
|
8
|
+
- Adds `docs/brand.md` with recommended GitHub repository description, topics, and UI asset guidance.
|
|
9
|
+
- Updates the npm package description and keywords to better reflect maintainer-readiness, GitHub Action, SARIF, and inventory workflows.
|
|
10
|
+
- Updates the GitHub Action metadata description and branding icon.
|
|
11
|
+
|
|
12
|
+
## Verification
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm run check
|
|
16
|
+
npm publish --dry-run
|
|
17
|
+
```
|
package/docs/release-process.md
CHANGED
|
@@ -49,11 +49,11 @@ git push origin main --tags
|
|
|
49
49
|
|
|
50
50
|
Create a GitHub Release for the tag and use the release notes in `docs/release-notes/` when available.
|
|
51
51
|
|
|
52
|
-
For example, `v0.6.
|
|
52
|
+
For example, `v0.6.4` uses [docs/release-notes/v0.6.4.md](release-notes/v0.6.4.md).
|
|
53
53
|
|
|
54
54
|
## npm Publish
|
|
55
55
|
|
|
56
|
-
Manual publish path:
|
|
56
|
+
Manual publish path, used only as a fallback:
|
|
57
57
|
|
|
58
58
|
```bash
|
|
59
59
|
npm publish --access public
|
|
@@ -61,14 +61,14 @@ npm publish --access public
|
|
|
61
61
|
|
|
62
62
|
Automation path:
|
|
63
63
|
|
|
64
|
-
The tag-triggered [release workflow](../.github/workflows/release.yml) runs the same checks
|
|
64
|
+
The tag-triggered [release workflow](../.github/workflows/release.yml) runs the same checks, verifies the package with `npm publish --dry-run`, creates a GitHub Release, and publishes to npm with Trusted Publishing provenance.
|
|
65
65
|
|
|
66
|
-
|
|
66
|
+
Trusted Publishing must be configured on npm for:
|
|
67
67
|
|
|
68
|
-
-
|
|
69
|
-
- Repository
|
|
70
|
-
|
|
71
|
-
|
|
68
|
+
- Package: `oss-signal`
|
|
69
|
+
- Repository: `SalmonPlays/oss-signal`
|
|
70
|
+
- Workflow file: `release.yml`
|
|
71
|
+
- Permission: npm publish
|
|
72
72
|
|
|
73
73
|
## Post-Release Verification
|
|
74
74
|
|
|
@@ -1,9 +1,13 @@
|
|
|
1
1
|
# Reviewer Evidence Quickstart
|
|
2
2
|
|
|
3
|
-
Last verified: 2026-06-
|
|
3
|
+
Last verified: 2026-06-04T03:01:28Z
|
|
4
4
|
|
|
5
5
|
This page gives reviewers a short path to verify that `oss-signal` is a real OSS maintainer workflow tool, not only a demo repository.
|
|
6
6
|
|
|
7
|
+
## Application Version Note
|
|
8
|
+
|
|
9
|
+
The Codex for Open Source application was submitted on 2026-06-03. The npm package and Action tag continued to move after submission as normal OSS maintenance. If any submitted field references older evidence, treat `0.6.4` as the current maintained release and see [post-submission-update.md](post-submission-update.md).
|
|
10
|
+
|
|
7
11
|
## Five-Minute Verification
|
|
8
12
|
|
|
9
13
|
1. Confirm the public package:
|
|
@@ -12,12 +16,12 @@ This page gives reviewers a short path to verify that `oss-signal` is a real OSS
|
|
|
12
16
|
npm view oss-signal version dist-tags --json
|
|
13
17
|
```
|
|
14
18
|
|
|
15
|
-
Expected result: `version` is `0.6.
|
|
19
|
+
Expected result: `version` is `0.6.4`, and `dist-tags.latest` is `0.6.4`.
|
|
16
20
|
|
|
17
21
|
2. Run the published package against the public repository:
|
|
18
22
|
|
|
19
23
|
```bash
|
|
20
|
-
npm exec --yes --package=oss-signal@0.6.
|
|
24
|
+
npm exec --yes --package=oss-signal@0.6.4 -- oss-signal SalmonPlays/oss-signal --format json
|
|
21
25
|
```
|
|
22
26
|
|
|
23
27
|
Expected result: score `100`, grade `A`, source `github`.
|
|
@@ -40,8 +44,8 @@ Expected result: a Markdown table with one row per repository, average score, sc
|
|
|
40
44
|
|
|
41
45
|
5. Inspect the public Action tag:
|
|
42
46
|
|
|
43
|
-
- Action tag: https://github.com/SalmonPlays/oss-signal/tree/v0.6.
|
|
44
|
-
- Release: https://github.com/SalmonPlays/oss-signal/releases/tag/v0.6.
|
|
47
|
+
- Action tag: https://github.com/SalmonPlays/oss-signal/tree/v0.6.4
|
|
48
|
+
- Release: https://github.com/SalmonPlays/oss-signal/releases/tag/v0.6.4
|
|
45
49
|
- Action metadata: [../action.yml](../action.yml)
|
|
46
50
|
|
|
47
51
|
6. Inspect field-audit evidence:
|
|
@@ -67,7 +71,9 @@ This project does not claim broad independent adoption yet. The separate workflo
|
|
|
67
71
|
|
|
68
72
|
## Primary Evidence Pages
|
|
69
73
|
|
|
74
|
+
- Brand assets and GitHub settings copy: [brand.md](brand.md)
|
|
70
75
|
- Adoption evidence: [adoption-evidence.md](adoption-evidence.md)
|
|
76
|
+
- Post-submission update: [post-submission-update.md](post-submission-update.md)
|
|
71
77
|
- Maintainer playbook: [maintainer-playbook.md](maintainer-playbook.md)
|
|
72
78
|
- Release process: [release-process.md](release-process.md)
|
|
73
79
|
- Rules and scoring weights: [rules.md](rules.md)
|
package/docs/self-audit.md
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "oss-signal",
|
|
3
|
-
"version": "0.6.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.6.4",
|
|
4
|
+
"description": "Maintainer-readiness CLI and GitHub Action for OSS triage, CI evidence, inventory reports, SARIF, and issue-ready cleanup.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
7
7
|
"oss-signal": "src/cli.js"
|
|
@@ -34,8 +34,12 @@
|
|
|
34
34
|
"keywords": [
|
|
35
35
|
"open-source",
|
|
36
36
|
"maintainer",
|
|
37
|
+
"maintainer-tools",
|
|
37
38
|
"audit",
|
|
38
39
|
"repository",
|
|
40
|
+
"repository-health",
|
|
41
|
+
"github-action",
|
|
42
|
+
"sarif",
|
|
39
43
|
"cli"
|
|
40
44
|
],
|
|
41
45
|
"author": "SalmonPlays",
|