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

refactor(core): rename @aws-cdk/cdk to @aws-cdk/core #2932

Merged
merged 3 commits into from
Jun 23, 2019

Conversation

eladb
Copy link
Contributor

@eladb eladb commented Jun 19, 2019

Rename the module @aws-cdk/cdk to @aws-cdk/core since this is a more suitable name for it.

Language-specific names:

  • Python: aws_cdk.core (renamed)
  • .NET: Amazon.CDK (not renamed)
  • Java: only artifactId changed to core but package and groupId are still software.amazon.awscdk

This change completely deletes the @aws-cdk/cdk module from the repo as a temporary measure, to ensure there are no lingering references. A subsequent commit will introduce @aws-cdk/cdk as a deprecated package.

Fixed #2733

BREAKING CHANGE: The @aws-cdk/cdk module was renamed to @aws-cdk/core

  • Python: The aws_cdk.cdk module was renamed to aws_cdk.core
  • Java: The artifact cdk in groupId software.amazon.awscdk was renamed to core

TODO:

  • Create a deprecated @aws-cdk/cdk module (maybe in a subsequent PR).

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

@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.

rename @aws-cdk/cdk to @aws-cdk/core
3 participants