Code Monkey home page Code Monkey logo

codepipeline-enricher's Introduction

codepipeline-enricher

Lambda function which enriches codepipeline notifications with additional data

How it works

Picks up AWS CodeStar notifications from an SQS queue and enriches them with additional details. It is designed to work with the following types of notification:

  • codepipeline-pipeline-pipeline-execution-failed
  • codepipeline-pipeline-pipeline-execution-canceled
  • codepipeline-pipeline-pipeline-execution-started
  • codepipeline-pipeline-pipeline-execution-resumed
  • codepipeline-pipeline-pipeline-execution-succeeded
  • codepipeline-pipeline-pipeline-execution-superseded

You can find more details on these notifications here: https://docs.aws.amazon.com/codestar-notifications/latest/userguide/concepts.html#concepts-api

What enrichment is done

The code collects details about the source which triggered the pipeline to run. It expects it to be a Github repository and adds those details to the message before posting it to another SQS queue.

How to set-up

You will need to create an SQS queue and subscribe it to the SNS topic to which codepipeline is sending notifications. This lambda function should be triggered by that queue. the lambda function needs two environment variables:

  • region: the region in which it is running
  • queue: the name of the SQS queue where the enriched message should be placed.

Note:

You may want to set a delivery delay on the SQS queue with the codepipeline notifications on it as I've found that the get-pipeline-execution API call does not always work when called very soon after an execution has begun - it is eventually consistent. I use a delay of 10 seconds.

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-enricher'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.