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

feat(cdk-test): check API compatibility #2356

Merged
merged 4 commits into from
Apr 26, 2019
Merged

feat(cdk-test): check API compatibility #2356

merged 4 commits into from
Apr 26, 2019

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Apr 23, 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 #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

  • Testing
    • Unit test added (prefer not to modify an existing test, otherwise, it's probably a breaking change)
    • CLI change?: coordinate update of integration tests with team
    • cdk-init template change?: coordinated update of integration tests with team
  • Docs
    • jsdocs: All public APIs documented
    • README: README and/or documentation topic updated
    • Design: For significant features, design document added to design folder
  • Title and Description
    • Change type: title prefixed with fix, feat and module name in parens, which will appear in changelog
    • Title: use lower-case and doesn't end with a period
    • Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
    • Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
  • Sensitive Modules (requires 2 PR approvers)
    • IAM Policy Document (in @aws-cdk/aws-iam)
    • EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
    • Grant APIs (only if not based on official documentation with a reference)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.

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.
@rix0rrr rix0rrr requested a review from a team as a code owner April 23, 2019 09:14
// published version)
if (!args.quick) {
try {
await shell([args["jsii-diff"], 'npm:'], { timers });
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks odd to have npm: here...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

@@ -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()));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

chunk might include an incomplete multi-byte unicode point, and this would effectively corrupt it 😕

@rix0rrr rix0rrr merged commit 1642925 into master Apr 26, 2019
@rix0rrr rix0rrr deleted the huijbers/compat branch April 26, 2019 09:57
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.
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants