Integrating AWS CodePipeline with the GitHub Commit Status API

[jewelsjacobs]

I have a business requirement to display commit status' in our full github development workflow

This requires CodePipeline to be set up with the Github Status API https://github.blog/2012-09-04-commit-status-api/

Here is an example of implementing this with AWS CodePipeline, Amazon CloudWatch and AWS Lambda:
https://scratchpad.blog/2019/03/16/integrating-aws-codepipeline-with-the-github-commit-status-api.html

It would be even better to set this up through CDK!

Thanks :)

[skinny85]

Like I said before in our Gitter channel, this issue is about CodePipeline; the CodeBuild integration is automatic, described here: https://github.com/awslabs/aws-cdk/blob/master/packages/%40aws-cdk/aws-codebuild/README.md#githubsource-and-githubenterprisesource

[jewelsjacobs]

I'm sorry this isn't a PR but maybe you can use this. I'm using it in my pipeline and it works.

Github Stage Status Construct: https://gist.github.com/jewelsjacobs/a0b627f3b9a176fbbb0d98f8ff7b1fea

Github Status API Lambda:
https://gist.github.com/jewelsjacobs/8a27147afbb265cbb1c1dd6782c2de44

How the construct works in a pipeline stack(I'm using it on a build stage but it can be easily used in a multistage iteration type scenario):

https://gist.github.com/jewelsjacobs/7262100a2f45e6b68659b70edacc64cf#file-pipeline-stack-ts-L162-L165

Screenshots:

[jewelsjacobs]

@skinny85 I'm going to attempt to create a PR for this. Stay tuned ....

[jewelsjacobs]

I'm sorry but I don't have off hours time to contribute this 😦

[gbooth27]

@jewelsjacobs thanks so much for putting this together! just used the code you linked in your comment after stumbling through this myself for several hours and worked like a charm. any news on when this might get integrated directly into CDK?

[corrjo]

@jewelsjacobs, would you mind if I use your code as a starting point for a PR to get this into aws-cdk?

@skinny85 Is a lambda like this an acceptable addition? I'm unaware of any other instances in aws-cdk where a lambda is used to extend base functionality of a resource. If you think this would work and know of any other examples, I'd like to make sure we have consistency between additions of this type.

[jewelsjacobs]

@corrjo go for it!

I don't know if this is better. It's older and a package-able npm mod here:

https://github.com/NewEraCodeRepo/nec-cdk-components
https://github.com/NewEraCodeRepo/nec-cdk-components/tree/master/packages/cdk-codepipeline-github

[skinny85]

@skinny85 Is a lambda like this an acceptable addition? I'm unaware of any other instances in aws-cdk where a lambda is used to extend base functionality of a resource. If you think this would work and know of any other examples, I'd like to make sure we have consistency between additions of this type.

Absolutely 🙂. There are many places in the CDK where we use Lambda-backed CloudFormation custom resources to add some functionality not available otherwise:

• s3-deployment module
• S3 notifications
• DNS-validated Route53 certificates

Good luck!

[NGL321]

Reviewing old feature-requests, this still seems entirely valid.

[hoegertn]

I implemented a Github Status notifier as a custom construct but the Readme is still missing.
https://github.com/taimos/cdk-construct-github-notifier

If this is sth that might go into the core CDK I am happy to open a PR.

[corrjo]

@hoegertn go for it, I was going to and had implemented it in our internal construct library but we ended up moving to circleci internally and I never had a chance to finish adding it here.

[Dzhuneyt]

If somebody is still interested, I had it as a recurring need and created a CDK construct library for it: https://github.com/awesome-cdk/cdk-report-codepipeline-status-to-github

If you think this is worth going into the CDK core, I would love to invest some time to port it. Somebody from the maintainers can confirm?

[jaredtbates]

@Dzhuneyt we would welcome this - we are also looking for this functionality with CDK Pipelines when source from a GitHub repository. not sure if that is part of this issue though.

[github-actions[bot]]

This issue has not received any attention in 1 year. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.

[Dzhuneyt]

Still relevant in 2022.

[rvargs]

In Mid-2024 as well.

[ahammond]

I'd love to have a way to do this for the various waves in our pipelines. So, add a context differentiator. Then see a bunch of statuses pop up:

cdkPipeline/QA: Success
cdkPipeline/Staging: Success
cdkPipeline/Prod: Pending

[madeline-k]

Hi all, as of now, we do not plan to implement this in the AWS CDK. If this feature is added to CodePipeline, then we would definitely consider adding CDK support. But as it is right now, we think it would be better for this feature to exist in a 3rd party library or in "user-land" CDK code.

Rather than close the issue, I'm converting it to a discussion. There is valuable info here about workarounds and how to do it yourself, that we still want customers to be able to find.

[ahammond]

@madeline-k do you plan to at least expose the underlying stage.onStageChange() method in cdkPipelines? Asking because that would enable this and other solutions. Or was there another workaround / do-it-yourself solution you were referring to?

[madeline-k]

Hey @ahammond, we would definitely be open to exposing additional properties if it helps people build their own constructs or integrations to do this. Can you be more specific about the onStageChange() method that you want exposed? I'm not familiar with that, and couldn't find it on a quick search through the codebase.

The DIY solution I was referring to is what is being described above: #24330 (comment) I haven't personally tested this, but taking #24330 (comment) as evidence that it works.

[ahammond]

@madeline-k my bad, I typo'd it. Should be stage.onStateChange(). See the example: https://github.com/NewEraCodeRepo/nec-cdk-components/blob/master/packages/cdk-codepipeline-github/src/cdk-codepipeline-github.ts#L106

Per the above example, this is available on aws-cdk-lib/aws-codepipeline/IStage. See

aws-cdk/packages/@aws-cdk/aws-codepipeline/lib/action.ts

Line 296 in 7dd8b7e

onStateChange(name: string, target?: events.IRuleTarget, options?: events.RuleProps): events.Rule;

However, I don't see it available on a cdkPipelines aws-cdk-lib/Stage. See

aws-cdk/packages/@aws-cdk/core/lib/stage.ts

Line 85 in 7dd8b7e

export class Stage extends Construct {

My understanding is that while there isn't a direct mapping between the two, they're very closely related. If we could get onStateChange() support on the cdkPipeline.Stage, we would be able to implement the above.

This should also be available on Waves:

aws-cdk/packages/@aws-cdk/pipelines/lib/blueprint/wave.ts

Line 27 in 7dd8b7e

export class Wave {

so that implement things like "do a thing when you start / complete deploying to all of production".

[ahammond]

@madeline-k while you're there, adding something like

export interface IHasAddStage {
  public addStage(stage: cdk.Stage, options: AddStageOpts);
}

...

export class Wave implementes IHasAddStage {}

...

export class CodePipeline extends PipelineBase implements IHasAddStage {}

Would enable people to write things like

function myAddStage(to: IHasAddStage, ...) {
  to.addStage(...);
}

which could be either passed the pipeline directly or a wave. We already do something like this in our CdkPipelines, but... it sure ain't elegant.

[ilfa]

Native integration works so cool for Azure and I can add some restrictions based on the pipeline result.

When for CodePipilene I had to provide my personal access token and commit status provided from my name as a result.