Open
Description
According to the API Extractor documentation about the API report, it is possible to detect API changes.
To see it in action, check https://github.com/dinerojs/dinero.js/blob/v2.0.0-alpha.14/scripts/build-types.mjs and the api.md
files in the sources.
This could be interesting to detect implicit/hidden breaking changes:
- from the
master
branch (detect in PR) - from the previous version (report for release notes)
Several time we almost forgot to manually detect breaking changes. For example in
- chore(eslint): use
unicorn/recommended
rules #2824 (comment): switchShapeUtil
from class to value object - switch
BpmnStyleIdentifier
from class to value object in refactor: use object instead of class for style identifiers #2716: initially not mentioned as "breaking change" - refactor!: transform StyleDefault into an object #2728 (detected)
- [FEAT] BpmnElementsRegistry API returns shape incoming/outgoing #2523 (detected)
- [FEAT] Detect Complex Gateway #2250 (detected)
- [REFACTOR] Replace StyleIdentifier by the BpmnStyleIdentifier class #1581: mentioned in https://github.com/process-analytics/bpmn-visualization-js/releases/tag/v0.20.0
- [REFACTOR] Rename ShapeBpmnEventKind into ShapeBpmnEventDefinitionKind #1580: mentioned in https://github.com/process-analytics/bpmn-visualization-js/releases/tag/v0.19.5
- ...
Questions
- is it able to detect breaking changes
- what are the automation capabilities?