Code Monkey home page Code Monkey logo

codepipeline-github-poster's Introduction

codepipeline-github-poster

A lambda function which posts status updates back to github to indicate CI/CD status

How it works

This lambda function picks up messages from an SQS queue and calls the Github status API to post information back to the source code repository which triggered the pipeline in the first place.

The Github API which is used is documented here https://developer.github.com/v3/repos/statuses/

It is designed to work with the codepipeline-enricher.

Messages

Messages are expected to be structured as follows

{
  "pipeline_name": "<name of the pipeline>", 
  "exec_id": "<pipeline execution id>", 
  "state": "<pipeline state>", 
  "github": {
    "owner": "<github order: user or team>", 
    "repo": "<github repository name>", 
    "branch": "<branch>", 
    "sha": "<commit sha hash>"
  }
}

Deploying

There is a terraform module which deploys this along with all the other bits and pieces it needs to work. You can find it here: https://github.com/richardjkendall/tf-modules/tree/master/modules/github-status-updater

codepipeline-github-poster's People

Contributors

richardjkendall avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.