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

[api-extractor] Add config options to customize the "API signature changed" notice #1207

Open
octogonz opened this issue Apr 4, 2019 · 2 comments
Labels
effort: easy Probably a quick fix. Want to contribute? :-) enhancement The issue is asking for a new feature or design change

Comments

@octogonz
Copy link
Collaborator

octogonz commented Apr 4, 2019

When API Extractor detects that the API report file has changed, it reports a notice to the end user.

If localBuild=false, you see this warning:

You have changed the public API signature for this project. 
Please overwrite ___ with a copy of ___ and then request an API review. 
See the Git repository README.md for more info.

If localBuild=true, you see this warning:

You have changed the public API signature for this project. Updating ___

We should provide a way to customize this message. Currently the only way to do that is to programmatically intercept API Extractor's logging, as seen in this workaround.

@octogonz octogonz added priority The maintainers consider it to be an important issue. We should try to fix it soon. effort: easy Probably a quick fix. Want to contribute? :-) enhancement The issue is asking for a new feature or design change and removed priority The maintainers consider it to be an important issue. We should try to fix it soon. labels Apr 4, 2019
@octogonz
Copy link
Collaborator Author

octogonz commented Apr 5, 2019

PR #1211 makes a workaround fairly easy if API Extractor is invoked programmatically.

@boomler
Copy link

boomler commented Jan 26, 2022

@octogonz How can i make it throws an error, when "API signature changed"?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort: easy Probably a quick fix. Want to contribute? :-) enhancement The issue is asking for a new feature or design change
Projects
Status: AE/AD
Development

No branches or pull requests

2 participants