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: deprecate "cloudformation" namespace in favor of "CfnXxx" #1311

Merged
merged 13 commits into from
Dec 13, 2018

Conversation

eladb
Copy link
Contributor

@eladb eladb commented Dec 9, 2018

Rename generated CloudFormation resource constructs from cloudformation.XxxResource to CfnXxx. This fixes #878 and eliminates the use of namespaces in the CDK.

This is done in a backwards compatible way, which means that we still generate the old resources under the cloudformation namespace so we can remove them in a subsequent release. Those resources also include a deprecation warning which is emitted upon cdk synth.

Documentation updated to reflect changes.

Related: aws/jsii#283 and aws/jsii#270


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.

Elad Ben-Israel added 2 commits December 9, 2018 13:51
Copy link
Contributor

@RomainMuller RomainMuller left a comment

Choose a reason for hiding this comment

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

That looks... maybe less dapper than I had imagined, but not too bad either.

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.

This is fine.

@eladb eladb requested review from skinny85 and a team as code owners December 13, 2018 09:10
@eladb eladb requested a review from Doug-AWS as a code owner December 13, 2018 09:48
@eladb eladb changed the title [WIP] feat: reorganize cloudformation resource constructs [WIP] feat: deprecate "cloudformation" namespace in favor of "CfnXxx" Dec 13, 2018
@eladb eladb changed the title [WIP] feat: deprecate "cloudformation" namespace in favor of "CfnXxx" feat: deprecate "cloudformation" namespace in favor of "CfnXxx" Dec 13, 2018
Copy link
Contributor

@skinny85 skinny85 left a comment

Choose a reason for hiding this comment

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

I like it. I think CfnBucket conveys L1-ness better than cloudformation.BucketResource did. 👍🏻

@eladb eladb merged commit d20938c into master Dec 13, 2018
@eladb eladb deleted the benisrae/yetanotherL1reorg branch December 13, 2018 21:51
@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
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consider removing cloudformation namespace
6 participants