[Feature Request] Cloudformation Badge Construct

[jewelsjacobs]

🚀 Feature Request

Dynamic Cloudformation Badge Construct

General Information

• 👋 I may be able to implement this feature request

• ⚠️ This feature might incur a breaking change

Description

There is NOTHING more annoying than having to update the CodeBuild / CodePipeline status badge manually on a github project repo README.md. Nothing. JK. It is annoying though.

Wouldn't it be great if there was a CDK construct you could add to your Codebuild / Codepipeline stack and an easy svg url to put on a readme that could make this easier?

Proposed Solution

Although I don't have a solution for a construct this person actually wrote a CF template that does this: https://github.com/galaxy4public/aws-cloudformation-badges

Because it's a stack level component the CDK version would look something like this:

const app = new cdk.App();

const pipeline1 = new PipelineStack(app, 'Pipeline1', env );
const pipeline2 = new PipelineStack(app, 'Pipeline2', env );
const pipeline3 = new PipelineStack(app, 'Pipeline3', env );

const project1 = new ProjectStack(app, 'Project1', env );
const project2 = new ProjectStack(app, 'Project2', env );
const project3 = new ProjectStack(app, 'Project3', env );

// following the parameters from the CF template included in the sample project
new CloudformationBadges(this, 'MyStatusBadge', {
  projects: ['project1', 'project2'],
  pipelines: ['pipeline1', 'pipeline2'],
})

Maybe v1 could incorporate a single project / pipeline.

Environment

• CDK CLI Version:
• Module Version:
• OS:
• Language:

Other information

[NGL321]

Hey @jewelsjacobs!

I really like this idea!
I am however, unsure of what the full scope of a construct for this would be.

Do you think it is something that could be integrated into the existing L2 constructs for Codebuild and Codepipeline, or is this something you are picturing as an independent construct?

😸

[jewelsjacobs]

@NGL321 Unfortunately my real job has pulled me into all my cdk stuff and it makes it really hard to help out as much as I want to ☹️
Our construct / module needs, tooling, etc are diverging so much from what y'all are doing at this point that I can't share / contribute. If we start to "cross paths" again I'll join up!

[NGL321]

@jewelsjacobs
No worries! There is a lot of support for this request, so I'm sure it will get attention in the near future.
If its alright, I'll keep using this issue to track the feature.

😸