banira diff

Compare two custom-elements.json files and report API changes with a suggested semver release type — useful as a release gate.

Usage

$ banira diff <baseline> <current> [options]

Arguments

ArgumentDescription
<baseline>Baseline custom-elements.json.
<current>Current custom-elements.json.

Options

OptionDescription
--jsonEmit the diff as JSON.
--changelog [path]Render a paste-ready Markdown CHANGELOG block (Added / Changed / Removed); optional output path.
--heading <text>Release heading for --changelog, e.g. a version. (default: Unreleased)

Examples

compare two manifests
$ banira diff old/custom-elements.json custom-elements.json
release notes for 1.4.0
$ banira diff old/custom-elements.json custom-elements.json --changelog --heading 1.4.0

Notes

Removals / type changes suggest major, additions suggest minor, otherwise patch. --changelog groups the same change set under ### Added / Changed / Removed with elements, attributes, events and properties/methods sub-headings. See CI & release for wiring it into a release gate.