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.

Sign up for GitHub

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

Jump to bottom

feat(toolkit): include toolkit version in AWS::CDK::Metadata #1287

Merged
merged 2 commits into from
Dec 5, 2018
Merged

feat(toolkit): include toolkit version in AWS::CDK::Metadata #1287

merged 2 commits into from
Dec 5, 2018

Conversation

eladb
Copy link
Contributor

@eladb eladb commented Dec 5, 2018 •
edited
Loading

Adds the AWS CDK Toolkit version to the modules list
of the AWS::CDK::Metadata resource to improve diagnosability
and analytics.

Fixes #1286

Pull Request Checklist

Please check all boxes (including N/A items)

Testing

  • Unit test and/or integration test added
  • Toolkit change?: integration
    tests
    manually executed (paste output to the PR description)
  • Init template change?: coordinated update of integration tests
    (currently maintained in a private repo).

Documentation

  • README: README and/or documentation topic updated
  • jsdocs: All public APIs documented

Title and description

  • Change type: Title is prefixed with change type:
    • fix(module): <title> bug fix (patch)
    • feat(module): <title> feature/capability (minor)
    • chore(module): <title> won't appear in changelog
    • build(module): <title> won't appear in changelog
  • Title format: Title uses lower case and doesn't end with a period
  • Breaking change?: Last paragraph of description is: BREAKING CHANGE: <describe exactly what changed and how to achieve similar behavior + link to documentation/gist/issue if more details are required>
  • References: Indicate issues fixed via: Fixes #xxx or Closes #xxx

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

feat(toolkit): include toolkit version in AWS::CDK::Metadata
d64fb43 
Adds the AWS CDK Toolkit version to the modules list
of the AWS::CDK::Metadata resource to improve diagnosability
and analytics.

Fixes #1286
@eladb eladb requested a review from a team December 5, 2018 08:47
@eladb
Copy link
Contributor Author

eladb commented Dec 5, 2018 

============================================================================================
test-cdk-context.sh
============================================================================================
Testing for the context value
Context value contextkey reset. It will be refreshed on the next SDK synthesis run.
No context value with key contextkey
✅  success
============================================================================================
test-cdk-deploy-all.sh
============================================================================================
| ensuring cdk-toolkit-integration-test-1 is cleaned up
| ensuring cdk-toolkit-integration-test-2 is cleaned up
cdk-toolkit-integration-test-1
cdk-toolkit-integration-test-1: deploying...
cdk-toolkit-integration-test-1: creating CloudFormation changeset...
 0/2 | 10:51:13 AM | CREATE_IN_PROGRESS   | AWS::SNS::Topic | topic (topic69831491)
 0/2 | 10:51:13 AM | CREATE_IN_PROGRESS   | AWS::SNS::Topic | topic (topic69831491) Resource creation Initiated
 1/2 | 10:51:24 AM | CREATE_COMPLETE      | AWS::SNS::Topic | topic (topic69831491)
 2/2 | 10:51:25 AM | CREATE_COMPLETE      | AWS::CloudFormation::Stack | cdk-toolkit-integration-test-1

 ✅  cdk-toolkit-integration-test-1

Stack ARN:
cdk-toolkit-integration-test-2
cdk-toolkit-integration-test-2: deploying...
cdk-toolkit-integration-test-2: creating CloudFormation changeset...
 0/3 | 10:51:42 AM | CREATE_IN_PROGRESS   | AWS::SNS::Topic | topic1 (topic152D84A37)
 0/3 | 10:51:42 AM | CREATE_IN_PROGRESS   | AWS::SNS::Topic | topic2 (topic2A4FB547F)
 0/3 | 10:51:43 AM | CREATE_IN_PROGRESS   | AWS::SNS::Topic | topic1 (topic152D84A37) Resource creation Initiated
 0/3 | 10:51:43 AM | CREATE_IN_PROGRESS   | AWS::SNS::Topic | topic2 (topic2A4FB547F) Resource creation Initiated
 1/3 | 10:51:53 AM | CREATE_COMPLETE      | AWS::SNS::Topic | topic1 (topic152D84A37)
 2/3 | 10:51:53 AM | CREATE_COMPLETE      | AWS::SNS::Topic | topic2 (topic2A4FB547F)
 3/3 | 10:51:55 AM | CREATE_COMPLETE      | AWS::CloudFormation::Stack | cdk-toolkit-integration-test-2

 ✅  cdk-toolkit-integration-test-2

Stack ARN:
Stack deployed successfully
cdk-toolkit-integration-test-1: destroying...

 ✅  cdk-toolkit-integration-test-1: destroyed
cdk-toolkit-integration-test-2: destroying...

 ✅  cdk-toolkit-integration-test-2: destroyed
✅  success
============================================================================================
test-cdk-deploy-with-role.sh
============================================================================================

An error occurred (NoSuchEntity) when calling the ListRolePolicies operation: The role with name cdk-integ-test-role cannot be found.

An error occurred (NoSuchEntity) when calling the DeleteRole operation: The role with name cdk-integ-test-role cannot be found.
Role does not exist yet
Sleeping a bit to improve chances of the role having propagated
| ensuring cdk-toolkit-integration-test-1 is cleaned up
| ensuring cdk-toolkit-integration-test-2 is cleaned up
cdk-toolkit-integration-test-2: deploying...
cdk-toolkit-integration-test-2: creating CloudFormation changeset...
 0/3 | 10:52:45 AM | CREATE_IN_PROGRESS   | AWS::SNS::Topic | topic2 (topic2A4FB547F)
 0/3 | 10:52:46 AM | CREATE_IN_PROGRESS   | AWS::SNS::Topic | topic2 (topic2A4FB547F) Resource creation Initiated
 0/3 | 10:52:46 AM | CREATE_IN_PROGRESS   | AWS::SNS::Topic | topic1 (topic152D84A37)
 0/3 | 10:52:46 AM | CREATE_IN_PROGRESS   | AWS::SNS::Topic | topic1 (topic152D84A37) Resource creation Initiated
 1/3 | 10:52:56 AM | CREATE_COMPLETE      | AWS::SNS::Topic | topic2 (topic2A4FB547F)
 2/3 | 10:52:57 AM | CREATE_COMPLETE      | AWS::SNS::Topic | topic1 (topic152D84A37)
 3/3 | 10:52:58 AM | CREATE_COMPLETE      | AWS::CloudFormation::Stack | cdk-toolkit-integration-test-2

 ✅  cdk-toolkit-integration-test-2

Stack ARN:
Stack deployed successfully
| assert that last command returned 1 line(s)
cdk-toolkit-integration-test-2: destroying...

 ✅  cdk-toolkit-integration-test-2: destroyed
✅  success
============================================================================================
test-cdk-deploy.sh
============================================================================================
| ensuring cdk-toolkit-integration-test-1 is cleaned up
| ensuring cdk-toolkit-integration-test-2 is cleaned up
cdk-toolkit-integration-test-2: deploying...
cdk-toolkit-integration-test-2: creating CloudFormation changeset...
 0/3 | 10:53:35 AM | CREATE_IN_PROGRESS   | AWS::SNS::Topic | topic2 (topic2A4FB547F)
 0/3 | 10:53:35 AM | CREATE_IN_PROGRESS   | AWS::SNS::Topic | topic1 (topic152D84A37)
 0/3 | 10:53:36 AM | CREATE_IN_PROGRESS   | AWS::SNS::Topic | topic2 (topic2A4FB547F) Resource creation Initiated
 0/3 | 10:53:36 AM | CREATE_IN_PROGRESS   | AWS::SNS::Topic | topic1 (topic152D84A37) Resource creation Initiated
 1/3 | 10:53:46 AM | CREATE_COMPLETE      | AWS::SNS::Topic | topic2 (topic2A4FB547F)
 2/3 | 10:53:46 AM | CREATE_COMPLETE      | AWS::SNS::Topic | topic1 (topic152D84A37)
 3/3 | 10:53:48 AM | CREATE_COMPLETE      | AWS::CloudFormation::Stack | cdk-toolkit-integration-test-2

 ✅  cdk-toolkit-integration-test-2

Stack ARN:
Stack deployed successfully
| assert that last command returned 1 line(s)
cdk-toolkit-integration-test-2: destroying...

 ✅  cdk-toolkit-integration-test-2: destroyed
✅  success
============================================================================================
test-cdk-diff.sh
============================================================================================
| ensuring cdk-toolkit-integration-test-1 is cleaned up
| ensuring cdk-toolkit-integration-test-2 is cleaned up
| assert that last command returned 2 line(s)
| assert that last command returned 3 line(s)
✅  success
============================================================================================
test-cdk-ls.sh
============================================================================================
| ensuring cdk-toolkit-integration-test-1 is cleaned up
| ensuring cdk-toolkit-integration-test-2 is cleaned up
| running cdk ls
✅  success
============================================================================================
test-cdk-synth.sh
============================================================================================
| ensuring cdk-toolkit-integration-test-1 is cleaned up
| ensuring cdk-toolkit-integration-test-2 is cleaned up
| running cdk synth cdk-toolkit-integration-test-1
| running cdk synth cdk-toolkit-integration-test-2
✅  success

rix0rrr
rix0rrr approved these changes Dec 5, 2018
View reviewed changes
Copy link
Contributor

@rix0rrr rix0rrr left a comment

Choose a reason for hiding this comment

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

Well that was easy.

@eladb eladb merged commit 5004f50 into master Dec 5, 2018
@eladb eladb deleted the benisrae/cdk-toolkit-version-in-metadata branch December 5, 2018 09:35
@eladb eladb self-assigned this Dec 5, 2018
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 23, 2019
@mergify
Copy link
Contributor

mergify bot commented Sep 23, 2019

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist:

  • PR title type(scope): text
    • type: fix, feat, refactor go into CHANGELOG, chore is hidden
    • scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
    • text: use all lower-case, do not end with a period, do not include issue refs
  • PR Description
    • Rationale: describe rationale of change and approach taken
    • Issues: indicate issues fixed via: fixes #xxx or closes #xxx
    • Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
  • Testing
    • Unit test added. Prefer to add a new test rather than modify existing tests
    • CLI or init templates change? Re-run/add CLI integration tests
  • Documentation
    • README: update module README to describe new features
    • API docs: public APIs must be documented. Copy from official AWS docs when possible
    • Design: for significant features, follow design process

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rix0rrr rix0rrr rix0rrr approved these changes

Assignees

@eladb eladb

Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add CDK::Metadata for CDK CLI version
3 participants
@eladb @rix0rrr @NGL321