Skip to content

[INFRA] Use API Extractor to detect API changes #2536

Open
@tbouffard

Description

@tbouffard

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

Questions

  • is it able to detect breaking changes
  • what are the automation capabilities?

Metadata

Metadata

Assignees

No one assigned

    Labels

    choreBuild, CI/CD or repository tasks (issues/PR maintenance, environments, ...)

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions