feat(jsii-diff): allow external stability to be treated as error #4076
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
rix0rrr
requested changes
May 1, 2023
rix0rrr
reviewed
May 2, 2023
mrgrain
force-pushed
the
mrgrain/feat/diff-external
branch
3 times, most recently
from
53bca30
to
84e50a2
Compare
mrgrain
force-pushed
the
mrgrain/feat/diff-external
branch
from
361942c
to
c28447f
Compare
rix0rrr
approved these changes
May 3, 2023
|
Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it! |
|
Merging (with squash)... |
mrgrain
changed the title
|
Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it! |
|
Merging (with squash)... |
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.
In certain situations one might want to treat changes to
externalAPIs as errors.This could be to check the external APIs for any breaking changes and have an opportunity to selectively reject, heal or soften an upstream change.
This change introduces a new cli option
--error-onwhich can be one of three classes:--error-onprod(default)stable,deprecatednon-experimentalstable,deprecated,externalallstable,deprecated,experimental,externalFixes
deprecatedAPIs not being treated asstable.In jsii, deprecations are treated as a stability.
However for the purpose of jsii-diff they should be treated as stable.
Otherwise one could do
stable -> deprecated, make breaking change, deprecated -> stable, which should not be allowed.We also can't prohibit the transition from deprecated back to stable, as it's perfectly okay to un-deprecate an API.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.