Skip to content

Finalize the names of the unstable modules in V2 #15576

@skinny85

Description

@skinny85

We need to decide on the exact names of the V2 unstable packages: things like the NodeJS module name, the Java groupId, artifactId, and Java package, C# package name and C# namespace, etc. - specifically, how they compare to their V1 counterparts. We need to choose the names deliberately so that the migration from V1 to V2 is as smooth as possible.

Right now, after #15442 has been merged, the names are:

  • NodeJS:
    • module name is @aws-cdk-lib-alpha/aws-<service> (compared to @aws-cdk/aws-<service>)
  • Java:
    • groupId: software.amazon.awscdk (same as V1)
    • artifactId: cdk-alpha.aws-<service> (compared to just <service> in V1)
    • Java package: software.amazon.awscdk.alpha.services.<service> (compared to software.amazon.awscdk.services.<service> in V1)
  • C#:
    • packageId: Amazon.CDK.AWS.<Service> (same as V1)
    • C# namespace: Amazon.CDK.Alpha.AWS.<Service> (as compared to Amazon.CDK.AWS.<Service> for V1)
  • Python:
    • distName: aws-cdk.alpha.aws-<service> (as compared to aws-cdk.aws-<service> in V1)
    • module: aws_cdk.alpha.aws_<service> (as compared to aws_cdk.aws_<service> in V1)
  • Go: no idea. Requires further investigation.

This might require changes in our pkglint rules.

It might also require changes to package manager permissions (for example, we might have to claim rights to a new scope in npmjs.org).

Metadata

Metadata

Assignees

No one assigned

    Labels

    aws-cdk-libRelated to the aws-cdk-lib packageeffort/smallSmall work item – less than a day of effortfeature-requestA feature should be added or improved.p1

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions