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

Pipelines: CodeStar Connections is now CodeConnections #31029

Open
zaq42 opened this issue Aug 6, 2024 · 2 comments
Open

Pipelines: CodeStar Connections is now CodeConnections #31029

zaq42 opened this issue Aug 6, 2024 · 2 comments
Labels
@aws-cdk/pipelines CDK Pipelines library documentation This is a problem with documentation. effort/large Large work item – several weeks of effort feature-request A feature should be added or improved. p2

Comments

@zaq42
Copy link

zaq42 commented Aug 6, 2024

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 zaq42 added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Aug 6, 2024
@github-actions github-actions bot added the @aws-cdk/pipelines CDK Pipelines library label Aug 6, 2024
@ashishdhingra ashishdhingra added investigating This issue is being investigated and/or work is in progress to resolve the issue. and removed needs-triage This issue or PR still needs to be triaged. labels Aug 6, 2024
@ashishdhingra ashishdhingra self-assigned this Aug 6, 2024
@ashishdhingra
Copy link
Contributor

ashishdhingra commented Aug 6, 2024

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 ashishdhingra added p2 effort/small Small work item – less than a day of effort and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Aug 6, 2024
@ashishdhingra ashishdhingra removed their assignment Aug 6, 2024
@ashishdhingra ashishdhingra added effort/medium Medium work item – several days of effort p1 effort/large Large work item – several weeks of effort and removed effort/small Small work item – less than a day of effort p2 effort/medium Medium work item – several days of effort labels Aug 6, 2024
@ashishdhingra
Copy link
Contributor

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

@ashishdhingra ashishdhingra added p2 and removed p1 labels Aug 7, 2024
@moelasmar moelasmar added the feature-request A feature should be added or improved. label Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/pipelines CDK Pipelines library documentation This is a problem with documentation. effort/large Large work item – several weeks of effort feature-request A feature should be added or improved. p2
Projects
None yet
Development

No branches or pull requests

3 participants