Add @microsoft/api-extractor to detect public API changes #1962
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* botframework-connector * adaptive-expressions (in preview) * botbuilder-lg (in preview)
Pull Request Test Coverage Report for Build 122038
💛 - Coveralls |
Member
Author
|
@BruceHaley as FYI. The ADO pipeline that specifically checks the public APIs is BotBuilder-JS-API-Check. (Build #116581) |
stevengum
changed the title
stevengum
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1903
Description
Using
@microsoft/api-extractorenables us to easily identify public API changes and avoid breaking changes.Developers should now use use
build:rollupto generate a source-controlled Markdown file that contains the public API of a package for a human friendly experience in reviewing API changes.Changing the public API and running
build:rollupshould result in updates to the package's.api.mdfile.Example: a developer changes the constructor for TestAdapter in botbuilder-core.
When they run
build:rollup, it should result inbotbuilder-core/etc/botbuilder-core.api.mdbeing changed.These changes should be committed before the PR is submitted for review, otherwise the CI will fail.
For an example PR that fails the API-Check, see #1963.
Specific Changes
.gitattributesto support JSON with comments.gitignoreto ignoretemp/anddist/folders"@microsoft/api-extractor": "^7.7.10"as a dependency for all libraries."build:rollup"- clears currentlib/, rebuilds and then runsapi-extractorapi-extractor run --verbose --localcreates a new<package-name>.api.mdinetc/which is checked into source control<package-name>.api.mdcontains the public APIs and is used to highlight any breaking changes"test:compat"- executesapi-extractor run --verbosebuild:rollupcommitted and added to the PRTesting
Created a ADO Pipeline to call
lerna run test:compatwhich fails on public API changes without a checked-in<package-name>.api.mdfile.