Reports

Roseau can write one or more report files during the same diff run.

Report Syntax

Reports are generated by passing the --report=FORMAT=PATH option to the CLI one or multiple times. Reports can also be configured in the YAML configuration file.

roseau --diff --v1 path/to/v1.jar --v2 path/to/v2.jar \
  --report JSON=reports/breaking-changes.json \
  --report HTML=reports/breaking-changes.html

An example HTML report is available here.

Format	Best fit
CLI	terminal-style text written to a file
CSV	review, diffing, and reuse with --ignored
HTML	human-readable report artifacts
JSON	automation and post-processing
MD	Markdown reports for release notes or pull requests