Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/rgfindl/functionci

FunctionCI is an open source Continuous Integration tool for AWS Lambdas.
https://github.com/rgfindl/functionci

aws-lambda continuous-integration serverless slack

Last synced: 4 months ago
JSON representation

FunctionCI is an open source Continuous Integration tool for AWS Lambdas.

Host: GitHub
URL: https://github.com/rgfindl/functionci
Owner: rgfindl
License: mit
Created: 2017-11-01T19:04:57.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2018-02-13T19:19:24.000Z (over 6 years ago)
Last Synced: 2024-01-16T06:20:25.726Z (5 months ago)
Topics: aws-lambda, continuous-integration, serverless, slack
Language: JavaScript
Homepage:
Size: 1.6 MB
Stars: 33
Watchers: 1
Forks: 7
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-serverless - FunctionCI - Continuous Integration for AWS Lambdas. (Others)

README

        


  



# Function CI

FunctionCI is an open source Continuous Integration tool for AWS Lambdas. 

Builds are done by AWS CodeBuild and AWS CodePipeline.  

Receive build notifications via Slack.  Deploy via Slack.  View build and deployment audit trails via Slack.

Fork this repo and install FunctionCI in your AWS account, then start managing your Lambdas properly.  

## Features

* Serverless - Function CI only costs money when you use it

* Github integration

* Slack bot

* Versioned build artifacts stored in S3

* Build and deployment audit trails with Github commit version and Slack username

## Table of content

- [Usage](#usage)

- [Setup](#setup)

- [Commands](#commands)

- [Architecture](#architecture)

## Usage

Use the `/fn create project` Slack command to create a new build project.



  



Once your build version is ready...



  



Deploy it using the `/fn deploy fn   ` Slack command.

Here is an example project: https://github.com/rgfindl/functionci-demo

## Setup

1. Fork and clone this repo.

2. Install [CIM](https://github.com/thestackshack/cim) (CloudFormation Utility)

3. Install the [kms](kms/README.md) stack.

4. Install the [app](app/README.md) stack.

** If you fix or add anything please submit a Pull Request!!!

## Commands

- [/fn create project](#fn-create-project)

- [/fn show projeect](#fn-show-project)

- [/fn show projeects](#fn-show-projects)

- [/fn delete projeect](#fn-delete-project)

- [/fn add fn](#fn-add-fn)

- [/fn show fn](#fn-show-fn)

- [/fn show fns](#fn-show-fns)

- [/fn deploy fn](#fn-deploy-fn)

- [/fn delete fn](#fn-delete-fn)

### /fn create project

`/fn create project`

Register a new Github repo that you wish FunctionCI to build.  

FunctionCI uses [CodeBuild](http://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html), so you will need a `buildspec.yml` in the root of your repo.

Here is an example `buildspec.yml` for a node.js project.  

** Note you must export a single zip artifact.

```

version: 0.2

# aws/codebuild/eb-nodejs-6.10.0-amazonlinux-64:4.0.0

phases:

  install:

    commands:

  pre_build:

    commands:

      - echo Installing source NPM dependencies...

      - npm install

  build:

    commands:

      - echo Testing the code

      - npm test

  post_build:

    commands:

      - echo Removing dev dependencies

      - rm -Rf node_modules

      - npm install --production

artifacts:

  files:

    - '**/*'

  type: zip

```

### /fn show project

`/fn show project `

Show the most recent builds in reverse chronological order.

The `project_id` will be `-`.  

Example:

* Repo: https://github.com/rgfindl/functionci-demo 

* Branch: master

The `project_id` == `functionci-demo-master`



  



### /fn show projects

`/fn show projects`

Show all the projects under management.

### /fn delete project

`/fn show project `

Delete the project and all build artifacts.

### /fn add fn

`/fn add fn  `

Add a Lambda function you wish to deploy build artifacts to.

Ex: `/fn add fn demo functionci-demo-LambdaFunction-LFREQ3DEC3UJ`

### /fn show fn

`/fn show fn `

Show a function and all its deployment history.

Ex: `/fn show fn demo`



  



### /fn show fns

`/fn show fns`

Show all the functions under management

Ex: `/fn show fns`

### /fn deploy fn

`/fn deploy fn   `

Deploy a build artifact to the Lambda function.

Ex: `/fn deploy fn demo functionci-demo-master 1`

### /fn delete fn

`/fn delete fn `

Delete a function and all its deployment history.

Ex: `/fn delete fn demo`

## Architecture

FunctionCI is also a serverless Lambda app.  It includes the following AWS resources:

* API Gateway (Exposes an API for our Slack bot)

* Lambda (Slack bot API, SNS events, CloudWatch events, CodePipeline events)

* DynamoDB (Document storage)

* S3 (Build artifacts)

* CloudFormation (Builds a pipeline for each project)

* CodePipeline and CodeBuild (Performs builds)

### Create Project

When you create a new project FunctionCI creates a new CloudFormation stack.  This stack is the build pipeline for your project.



  



### Build Project

When you commit changes to your Github repo CodePipeline is triggered.  The first CodePipeline stage is CodeBuild to build, test, and package your app.  The next CodePipeline stage is the FunctionCI Lambda to version and archive the build artifact.  



  



### Deploy Lambda

Now we are ready to deploy our build artifact to our Lambda.