Skip to content
This repository has been archived by the owner on Oct 14, 2021. It is now read-only.

Add support for highlighting breaking API changes #21

Open
2 tasks
jverkoey opened this issue Mar 7, 2018 · 0 comments
Open
2 tasks

Add support for highlighting breaking API changes #21

jverkoey opened this issue Mar 7, 2018 · 0 comments
Labels
Feature request

Comments

@jverkoey
Copy link
Contributor

jverkoey commented Mar 7, 2018

From alexisgallagher:

Does it auto generate an indication when the API change breaks compatibility for code that depended on the old API?

Things we need to do to make this happen:

  • Add a new API to ApiChange for isBreaking().
  • If an ApiChange is a breaking change, output additional markdown highlighting this fact.

It may make sense to aggregate breaking API changes near the top of the output as well.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Feature request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jverkoey