Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
tbouffard opened this issue Feb 22, 2023 · 0 comments
Open

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

tbouffard opened this issue Feb 22, 2023 · 0 comments
Labels
chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...)

Comments

@tbouffard
Copy link
Member

tbouffard commented Feb 22, 2023

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?
@tbouffard tbouffard added the chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...) label Feb 22, 2023
@tbouffard tbouffard added this to the Development Impediments milestone Feb 22, 2023
@tbouffard tbouffard modified the milestones: 0.42.0, 0.43.0 Oct 16, 2023
@tbouffard tbouffard modified the milestones: 0.43.0, 0.43.1 Feb 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...)
Projects
None yet
Development

No branches or pull requests

1 participant