build: remove unnecessary stability check #23176
Closed
Conversation
This file contains 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
petebacondarwin
added
area: build & ci
alexeagle
approved these changes
Apr 4, 2018
petebacondarwin
force-pushed
the
ts-guardian-stability-check
branch
from
c938ffa
to
cffce7f
Compare
petebacondarwin
added
action: merge
|
@alexeagle can you approve again please :-) |
alexeagle
approved these changes
Apr 5, 2018
|
Right I will update the commit message. |
Previously, it was necessary to attach on of the three "stability" jsdoc tags (`@stable`, `@deprecated` or `@experimental`) to each public API export. To ensure that the public API was correctly tagged, the `ts-api-guardian` would check that one of these tags appeared on every public export. Now the doc-gen is able to compute that a code item is stable if it does not contain the `@experimental` nor `@deprecated` tags. Therefore there is no need to provide the `@stable` tag any more; and this tag has now been marked as deprecated - i.e. it should not be used. The ts-api-guardian has been modified in this commit so that it no longer warns/fails if the `@stable` is missing.
petebacondarwin
force-pushed
the
ts-guardian-stability-check
branch
from
cffce7f
to
5fda66a
Compare
IgorMinar
approved these changes
Apr 5, 2018
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
PR Checklist
Please check if your PR fulfills the following requirements:
added/ removed (for bug fixes / features)added/ removed (for bug fixes / features)PR Type
What kind of change does this PR introduce?
What is the current behavior?
The doc-gen now assumes that a code item is stable if
it does not contain neither
@experimentalnor@deprecatedtags.What is the new behavior?
The ts-api-guardian no longer warns if the
@stabletag is missing.Does this PR introduce a breaking change?
Other information
Discussed with @IgorMinar