Azure / Azure/azure-sdk-tools

Feature request: detect potential API breaking change for Typescript/JS in APIview

Open
#3,524 2 comments 0 reactions 2 assignees Claimed by @jeremymeng View on GitHub
APIView EngSys Javascript
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

Scenario 1:

Select two revisions and diff is shown, along with warnings/errors for potential breaking changes from rev x->y.

Scenario 2:

Pin a API view url as a base (along with its revision) and select a revision from another API view for diff. Then get warnings/errors for potential breaking changes from url a rev x-> url b rev y.

This scenario is for the case Devs are tracking APIs in different api-views or they want to recreate a baseline one because existing apiviews don't represent properly the correct baseline that is released.

Breaking changes:

Warn only initially, so it can be a bit more "aggressive" biasing towards detecting more cases over accuracy (it's fine to warn false-break-changes, that is just to help devs to not miss anything before releasing).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.