feat(cdk-test): check API compatibility #2356
Merged
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
Add a check to `cdk-test` to confirm that no breaking API changes have been introduced with respect to the most recently published version. Because this will incur an NPM fetch, add a flag (`--quick`/`-q`) to disable it. Addresses #145.
RomainMuller
approved these changes
Apr 23, 2019
| // published version) | ||
| if (!args.quick) { | ||
| try { | ||
| await shell([args["jsii-diff"], 'npm:'], { timers }); |
There was a problem hiding this comment.
It looks odd to have npm: here...
There was a problem hiding this comment.
In a newer drop of jsii-diff we can change it to npm:// if that makes you feel better. But that is not out yet.
There was a problem hiding this comment.
It's more the fact that it looks like there should be something afterwards... And there's nothing...
| }); | ||
|
|
||
| const makeRed = process.stderr.isTTY ? colors.red : (x: string) => x; |
| @@ -27,6 +34,10 @@ export async function shell(command: string[], timers?: Timers): Promise<string> | |||
| stdout.push(chunk); | |||
| }); | |||
|
|
|||
| child.stderr!.on('data', chunk => { | |||
| process.stderr.write(makeRed(chunk.toString())); | |||
There was a problem hiding this comment.
chunk might include an incomplete multi-byte unicode point, and this would effectively corrupt it 😕
SanderKnape
pushed a commit
to SanderKnape/aws-cdk
that referenced
this pull request
May 14, 2019
Add a check to `cdk-test` to confirm that no breaking API changes have been introduced with respect to the most recently published version. Because this will incur an NPM fetch, add a flag (`--quick`/`-q`) to disable it. Addresses aws#145.
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.
Add a check to
cdk-testto confirm that no breaking API changeshave been introduced with respect to the most recently published
version.
Because this will incur an NPM fetch, add a flag (
--quick/-q) todisable it.
Addresses #145.
There is no point in merging this before a version of CDK has been
released with the new assembly version (of jsii 10) as this
tool cannot load nor validate assemblies currently published.
Pull Request Checklist
designfolderBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.