anasm266/ApiBump
Detect public API breakages and recommend SemVer bumps.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| language | Language backend to run. V1 supports python. | no | python |
| package | Python package/module name to check. Optional when autodetect or config can resolve it. | no | — |
| search | Search path passed to Griffe, usually src or . Optional when autodetect or config can resolve it. | no | "" |
| config | Optional apibump.toml path relative to the repository root. | no | "" |
| all-packages | Check all configured or detected packages instead of only changed ones. | no | false |
| base | Older git ref to compare from. | yes | — |
| head | Newer git ref to compare to. | no | HEAD |
| fail-on | Failure policy: breaking, unknown, or never. | no | breaking |
| comment | Post or update a sticky PR comment. | no | true |
| github-token | Token used for PR comments. | no | "" |
| format | Log output format: human, json, markdown, or github. | no | github |
| version | ApiBump release version to download. | no | v0.2.4 |
Outputs
| name | description |
|---|---|
| recommendation | Recommended SemVer bump. |
| breaking | Number of breaking changes. |
| unknown | Number of unknown changes. |
| json-file | Path to the JSON report on the runner. |
| markdown-file | Path to the Markdown report on the runner. |
| exit-code | ApiBump CLI exit code after applying the failure policy. |