[aws-codepipeline-actions] Support for CodeStar Connections in GitHubSourceAction

[akuma12]

CodePipeline is recommending the use of the new CodeStar Connections when creating GitHub source actions. The GitHubSourceAction class doesn't currently support passing in a CodeStar Connection ARN.

Use Case

This would allow us to create GitHub sources that utilize the AWS Github Connector app. We can set this up via CloudFormation, but currently not via CDK. This would also have the side effect of enabling GitHub Enterprise Server connections within CDK.

Proposed Solution

Implement a new CodeStarSourceConnectionAction that mimics the parameters defined inhttps://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodestarConnectionSource.html

Other

The current GitHubSourceAction is working for us, but the new CodeStar Connection system would be a nice option, and more secure than using a machine account with a personal OAuth token.

• 👋 I may be able to implement this feature request
• ⚠️ This feature might incur a breaking change

---

This is a 🚀 Feature Request

[skinny85]

Hey @akuma12 ,

actually, you can try using the (poorly name) BitBucketSourceAction even for GitHub - it actually should work!

Let me know if it does. If it turns out it does, we might think of renaming it to make it more obvious it works for both.

Thanks,
Adam

[akuma12]

@skinny85 I never would have thought of that, I'll give it a whirl, thanks!

[akuma12]

@skinny85 That seems to work. I had an issue at first with the Source action getting triggered by a push, but then just hanging, but it started working after I did a little tear down and redeploy. Thank you so much!

[skinny85]

Sure 🙂. Re-opening so we can track the re-naming work.

[bryan-hunter]

I started to migrate to using BitBucketSourceAction but noticed that AWS Codestar connections don't allow you to disable the trigger (ie: NONE, POLL, WEBHOOK that's available on the Github one).

I have a situation where I want to source a pipeline's code from Github, but I don't want to trigger the pipeline on a merge.

Is this a limitation of AWS Codestar or can anyone think of a fancy way to accomplish disabling the trigger without having to manage something like pushing code to S3 and sourcing from there?

[caedmon-polly]

If this is going to replace the GitHubSourceAction it would be nice if it would also emit the variables that are emitted by GitHubSourceAction.

[jmayergit]

Poorly named indeed XD

Thank you ! @skinny85

[jonathan-kosgei]

@skinny85 will this get renamed or should we just use BitBucketSourceAction?

[skinny85]

There will be a new Action class created, something like CodeStarConnectionsSourceAction, but we won't remove BitBucketSourceAction, so feel free to use it until that happens 🙂.

[bryan-hunter]

I started to migrate to using BitBucketSourceAction but noticed that AWS Codestar connections don't allow you to disable the trigger (ie: NONE, POLL, WEBHOOK that's available on the Github one).

I have a situation where I want to source a pipeline's code from Github, but I don't want to trigger the pipeline on a merge.

Is this a limitation of AWS Codestar or can anyone think of a fancy way to accomplish disabling the trigger without having to manage something like pushing code to S3 and sourcing from there?

Updating in case someone finds this issue:

The Github Version 2 Source action now supports this via DetectChanges in CloudFormation. This PR adds this capability to BitBucketSourceAction (which is used for new GithubSource connection now too): #13656

[danielwoerner]

any updates? if you know this PR will go through in the next few days, i can postpone development of our companies pipelines for until then. if not i guess i'll have to use the BitBucketSourceAction

[skinny85]

Go ahead and use BitBucketSourceAction. After this PR gets merged, it should just be a matter of "search + replace" BitBucketSourceAction to CodeStarConnectionsSourceAction (their APIs are identical).

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

[contrapunctus-xv]

How do we access variables with this now?

[skinny85]

@contrapunctus-xv we don't support variables on CodeStarConnectionsSourceAction today, even tough I see they are listed in the CodePipeline documentation. Would you mind opening us a Feature Request to add this capability?

In the meantime, you can work around this limitation by setting the variablesNamespace property of the Action:

          new codepipeline_actions.CodeStarConnectionsSourceAction({
            actionName: 'BitBucket',
            owner: 'aws',
            repo: 'aws-cdk',
            output: sourceOutput,
            connectionArn: 'arn:aws:codestar-connections:us-east-1:123456789012:connection/12345678-abcd-12ab-34cdef5678gh',
            variablesNamespace: 'MyNamespace',
          }),

And then using the '#{MyNamespace.VariableName}' notation, like so:

              new cpactions.CodeBuildAction({
                actionName: 'Build',
                project: new codebuild.PipelineProject(stack, 'MyProject'),
                input: sourceOutput,
                environmentVariables: {
                  AuthorDate: { value: '#{MyNamespace.AuthorDate}' },
                },
              }),

Hope this helps!

Thanks,
Adam