alien-tools/Roseau API Breaking Change Detection
Detect breaking changes between two versions of a Java library using Roseau
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jun 7, 2026
- License
- MIT
Pinned Snippet
uses: alien-tools/roseau-action@c7b6c48140a8b862e542b0370c587768bf64e367 # v1.1.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| baseline | Baseline version: Maven coordinates (g:a:v), local JAR, or source directory | no | — |
| current | Current version: Maven coordinates (g:a:v), local JAR, or source directory | no | — |
| v1 | Baseline version; legacy alias for baseline | no | — |
| v2 | Current version; legacy alias for current | no | — |
| fail-on-breaking-changes | Fail the step if breaking changes are found | no | true |
| fail-on-bc | Legacy alias for fail-on-breaking-changes | no | — |
| compatibility | Compatibility mode to check: all, binary, or source | no | all |
| binary-only | Legacy alias for compatibility=binary | no | false |
| source-only | Legacy alias for compatibility=source | no | false |
| ignored | Path to a CSV file listing accepted breaking changes | no | — |
| config | Path to a roseau.yaml configuration file | no | — |
| classpath | Extra classpath JARs shared by both versions | no | — |
| v1-classpath | Extra classpath JARs for the baseline version | no | — |
| v2-classpath | Extra classpath JARs for the current version | no | — |
| pom | POM used to extract a shared classpath | no | — |
| v1-pom | POM used to extract the baseline classpath | no | — |
| v2-pom | POM used to extract the current classpath | no | — |
| reports | Comma-separated FORMAT=PATH pairs for additional reports (e.g. HTML=report.html,CSV=report.csv) | no | — |
| report-dir | Directory where default reports are written | no | roseau-reports |
| upload-reports | Upload generated reports as a workflow artifact | no | true |
| comment | Post/update a PR comment with the breaking changes report | no | true |
| java-version | JDK version to set up | no | 25 |
| roseau-version | Roseau release version (e.g. v0.6.0), or 'latest' | no | latest |
Outputs
| name | description |
|---|---|
| has-breaking-changes | 'true' if breaking changes were detected, 'false' otherwise |
| breaking-change-count | Number of breaking changes detected |
| report-dir | Directory containing generated reports |
| json-report | Path to the generated JSON report |
| markdown-report | Path to the generated Markdown report |
| report-path | Legacy alias for json-report |