JSPM

@awesome-cdk/cdk-report-codepipeline-status-to-github

1.0.5
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2
  • Score
    100M100P100Q40638F
  • License MIT

An AWS CDK construct that, when attached to a CodePipeline, will make sure success or failure of that pipeline is reflected back to GitHub and shown next to the commit.

Package Exports

  • @awesome-cdk/cdk-report-codepipeline-status-to-github
  • @awesome-cdk/cdk-report-codepipeline-status-to-github/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@awesome-cdk/cdk-report-codepipeline-status-to-github) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Report CodePipeline build status to GitHub commit

An AWS CDK construct that, when attached to a CodePipeline, will make sure success or failure of that pipeline is reflected back to GitHub and shown next to the commit.

This is largely based on the reference architecture, proposed by AWS, minus the SNS topic, since it's not really needed.

Quick Start

// Create your pipeline with its Stages and all other configuration, as you would normally do it
const pipeline = new codepipeline.Pipeline(this, 'Pipeline', {});

// Use the construct from this package, passing a "Systems Manager - Parameter Store" where you've previously stored your GitHub "Personal Access Token"
const githubToken = StringParameter.fromStringParameterName(this, 'GitHubToken', 'GITHUB_TOKEN');
new CodePipelinePostToGitHub(pipeline, 'CodePipelinePostToGitHub', {
    pipeline,
    githubToken,
});