api-changelog-risk-scanner
Converts raw API contract diffs into evidence-based compatibility risk tiers and client-facing migration changelogs.
| Size | Folder | Inside |
|---|---|---|
| 243 B | examples/ | 2 examples |
| 5.2 kB | bin/ | 1 script |
| 1.7 kB | src/ | 1 source file |
| 385 B | tests/ | 1 test file |
| 5.4 kB | (root) | 4 docs · 1 asset |
| Size | Path |
|---|---|
| 2.1 kB | LICENSE |
| 434 B | QUICKSTART.md |
| 1.9 kB | README.md |
| 326 B | SECURITY.md |
| 6 B | VERSION · binary |
| 5.2 kB | bin/api-changelog-risk.js |
| 128 B | examples/v1.json |
| 115 B | examples/v2.json |
| 625 B | package.json |
| 1.7 kB | src/detector.js |
| 385 B | tests/test_detector.js |
Already bought this?
View your purchasesREADME
api-changelog-risk-scanner
Converts raw API contract diffs into evidence-based compatibility risk tiers and client-facing Markdown migration changelogs.
What Can Break?
API releases without clear migration notes, forcing client developers to reverse-engineer breaking modifications after production breaks.
What Does This Tool Check?
Computes Release Risk Score (0–100), classifies risk tier (LOW, MEDIUM, HIGH, CRITICAL), and generates Markdown changelog tables.
What Does It NOT Check?
Does not write marketing blog posts or track sales conversions.
How Fast Can I Run It?
Under 5 seconds. Zero external dependencies. Pure Node.js standard library.
# Clone and run
git clone git@github.com:genesiscode2026/api-changelog-risk-scanner.git
cd api-changelog-risk-scanner
# Execute 60-second demo
./bin/api-changelog-risk.js --help
./bin/api-changelog-risk.js --old examples/v1.json --new examples/v2.json
What Do I Get?
- Deterministic CLI Exit Codes: Returns code
0on backward-compatible contracts; returns code1on breaking drift. - Machine-Readable JSON: Pass
--jsonto integrate directly into GitHub Actions, GitLab CI, or pre-commit hooks. - Human-Readable Diffs: Clear, actionable error reports with exact field pointers.
Commercial Distribution
- Catalog ID:
P55 - Price Band: advanced CI utility ($29)
- List Price: $29 USD
- License: GENESIS Commercial Source License v1.0
- Seller:
genesiscode2026 - Official Storefront: Genesis Code on Getly
Security scan report
Scanned by X402 Git, OSV (opens in a new tab) and Socket (opens in a new tab) — passed on all three. Findings from X402 Git and Socket are listed below.
- secrets
- none found
- X402 Git
- size limits
- within caps
- X402 Git
- known malware
- no dependency manifests to check
- OSV
- known vulnerabilities
- no dependency manifests to check
- OSV
- dependency behaviour
- nothing on a direct dependency · 1 in transitive packages
- Socket
- instruction smuggling
- none found
- X402 Git
- what it can do
- listed below
- X402 Git
What this can do
- Tools
- none
- Runs
- bin/api-changelog-risk.js
- Talks to
- nothing
- Reads
- no environment variables
- At install
- nothing runs
- Links to
- img.shields.io
- www.getly.store
Findings (2)
- LOWSocket SBOM Resolver — Socket SBOM Resolver (transitive) — no lockfile, so installs are not reproducible
- LOWbin/api-changelog-risk.js — Ships the script bin/api-changelog-risk.js
Releases 1
- v1.0.02026-09-17
Commercial release v1.0.0 for api-changelog-risk-scanner