kyungseopk1m/semver-checks
Detect breaking changes in a TypeScript library's public API and recommend the correct SemVer bump.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| old | Old version: npm spec (for example, my-pkg@latest), git ref, or path. | yes | — |
| new | New version: git ref or path. Defaults to the checked-out working tree. | no | . |
| entry | Entry file (for example, src/index.ts). Auto-detected from package.json when omitted. | no | "" |
| format | Output format: text, json, markdown, or github for inline PR annotations. | no | github |
| strict | Fail the step on a confident (proven) breaking change. Safe to gate CI on. | no | false |
| strict-review | Fail the step on any breaking change, including review-only (heuristic) ones. | no | false |
| version | semver-checks version to run via npx. Defaults to the pinned action version (for example, @v0.7.0 runs semver-checks@0.7.0). | no | "" |
Outputs
no outputs