feat(jsii-diff): also check stability transitions #592
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
Once an API element is marked @stable, it is not allowed to retract that stability guarantee anymore by changing it back to @experimental. This is now verified by `jsii-diff`. This was always intended to be checked, but was missed as an oversight in the initial implementation.
RomainMuller
approved these changes
Jul 10, 2019
eladb
reviewed
Jul 10, 2019
| // Nothing to do in these cases | ||
| if (original.docs.stability === undefined || original.docs.stability === updated.docs.stability) { return; } | ||
|
|
||
| // Not allowed to disavow stability |
There was a problem hiding this comment.
Is that the case where stability is inherited? What happens if you change the stability of the oRent module/type, is it inherited by the Jsii compiler! Can we evened even have an undefined stability for an api?
Also, wasn’t this what we wanted to do for the CFN layer?
There was a problem hiding this comment.
Inheritance has already been calculated at this level. I thought for the CFN layer we introduce a new explicit stability level (imported), not (nothing).
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.
Once an API element is marked @stable, it is not allowed to
retract that stability guarantee anymore by changing it back to
@experimental. This is now verified by
jsii-diff.This was always intended to be checked, but was missed as an oversight
in the initial implementation.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.