aws-cdk icon indicating copy to clipboard operation
aws-cdk copied to clipboard

Pipelines: CodeStar Connections is now CodeConnections

Open zaq42 opened this issue 1 year ago • 2 comments

Describe the issue

Documentation for CodePipelineSource.connection says:

To use this method, you first need to create a CodeStar connection using the AWS console

The term "CodeStar connection" is confusing, since AWS CodeStar is now deprecated.

On July 31, 2024, Amazon Web Services (AWS) will discontinue support for creating and viewing AWS CodeStar projects.

However, what is needed is now under AWS CodeConnections (ref)

Posted On: Mar 29, 2024 AWS is renaming AWS CodeStar Connections to AWS CodeConnections.

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.pipelines.CodePipelineSource.html#static-connectionrepostring-branch-props

zaq42 avatar Aug 06 '24 03:08 zaq42

Findings:

  • CodeStar Connections is rebranded to CodeConnections.
  • Model changes are already in SDK (refer aws-models/codeconnections)
  • The shape HostArn allows string with pattern arn:aws(-[\\w]+)*:(codestar-connections|codeconnections):.+:[0-9]{12}:host\\/.+ (take a note that in some instances, it might use codestar-connections in ARN).
    • This is verified by manually creating a new connection to GitHub in CodePipeline AWS console where it created connection with ARN arn:aws:codestar-connections:us-east-2:<<account-id>>:connection/<<some-guid-value>>.

To update references in documentation, it is not required to change the ARN in the example.

There are also references to CodeStar Connections in Readme.

Also, although this appears to be a documentation only change, we still have codestar-connections in https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-codepipeline-actions/lib. CDK should deprecate that as well (at least to offer a new class). Needs discussion with the team.

ashishdhingra avatar Aug 06 '24 18:08 ashishdhingra

For now, we should update the Readme and API documentation string to mention about deprecation.

ashishdhingra avatar Aug 07 '24 18:08 ashishdhingra