bpmn-visualization-js icon indicating copy to clipboard operation
bpmn-visualization-js copied to clipboard

Published 20 hours ago • verified publisher icon process-analytics

[INFRA] Use API Extractor to detect API changes

Open tbouffard opened this issue 2 years ago • 0 comments

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

  • https://github.com/process-analytics/bpmn-visualization-js/pull/2824#discussion_r1338288402: switch ShapeUtil from class to value object
  • switch BpmnStyleIdentifier from class to value object in #2716: initially not mentioned as "breaking change"
  • #2728 (detected)
  • #2523 (detected)
  • #2250 (detected)
  • #1581: mentioned in https://github.com/process-analytics/bpmn-visualization-js/releases/tag/v0.20.0
  • #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?

tbouffard avatar Feb 22 '23 14:02 tbouffard