README
¶
CodePipeline → Lambda → Github
Update a GitHub commit status via CodePipeline events
Table of Contents
- Installation
- Deployment & Hosting
- Documentation
- Examples & Tests
- Code Standards
- Maintainers
- Contributing
- License
Installation
Prerequisites
Clone or go get the files locally
go get github.com/mrz1818/codepipeline-to-github
cd $GOPATH/src/github.com/mrz1818/codepipeline-to-github
Setup to run locally
1) Modify the event json to a recent pipeline execution and pipeline name
"detail": {
"pipeline": "your-pipeline-name",
"execution-id": "some-execution-id"
}
2) Modify the local-env.json file with your Github Personal Access Token
"StatusFunction": {
"GITHUB_ACCESS_TOKEN": "your-token-goes-here"
}
3) Finally, run the handler which should produce null as a success
make run event="started"
Deployment & Hosting
This repository has CI integration using AWS CodePipeline.
Deploying to the master branch will automatically start the process of shipping the code to AWS Lambda.
Any changes to the environment via the AWS CloudFormation template will be applied. The actual build process can be found in the buildspec.yml file.
The application relies on AWS Secrets Manager and SSM to store environment variables.
Create Environment Keys (AWS)
If you already have KMS keys for encrypting environment variables, you can skip this step.
1) Create a KMS Key in your console per <stage> for your application(s):
Example:
name = "<stage>EnvironmentVars"
description = "Encryption key for <stage> environment variables"
2) Store the KMS Key ID in SSM for global use
make save-param param_name="/<stage>/global/kms_key_id" param_value="YOUR_KMS_KEY_ID"
Create New Hosting Environment (AWS)
This will create a new AWS CloudFormation stack with:
- (1) Lambda Function(s)
- (1) CloudWatch Event Rule to subscribe to Pipeline events
- (1) CloudWatch LogGroups for Lambda Function(s)
- (1) CodePipeline with multiple stages to deploy the application from Github
- (1) CodePipeline Webhook to receive Github notifications from a specific
branch:name - (1) CodeBuild Project(s) to test, build and deploy the app
- (2) Service Roles for working with CodeBuild and CodePipeline
NOTE: Requires an existing S3 bucket for artifacts and sam-cli deployments (located in the Makefile)
The Github token is stored encrypted for use in Lambda (decrypted at runtime via KMS.
To be able to decrypt the token at runtime, the Lambda function will need permission to
access the KMS Key with the KeyID specified in SSM: /<stage>/global/kms_key_id
1) Add your Github personal access token (Only once per stage)
make save-token token="YOUR_GITHUB_TOKEN" kms_key_id="YOUR_KMS_KEY_ID" APPLICATION_STAGE_NAME="<stage>"
2) One command will build, test, package and deploy the application to AWS. After initial deployment, updating the function is as simple as committing to Github.
make deploy
(Example) Customized deployment for another stage/branch
make deploy APPLICATION_STAGE_NAME="development" REPO_BRANCH="development"
If you make any adjustments to the command above, update the buildspec file accordingly.
Tear Down Hosting Environment (AWS)
Remove the Stack(s)
make teardown
Lambda Logging
View all the logs in AWS CloudWatch via log groups:
/aws/lambda/<app_name>-<stage_name>-<function_name>
Documentation
The status handler is composed of:
- Processes incoming CloudWatch events from CodePipeline
- Decrypts environment variables (Github Token)
- Gets the latest information from CodePipeline via an ExecutionID
- Determine the Github status based on the Execution status
- Post request to Github to notify the status change
Run the status function with different events
make run event="failed"
Library Deployment
goreleaser for easy binary or library deployment to Github and can be installed via: brew install goreleaser.
The .goreleaser.yml file is used to configure goreleaser.
Use make release-snap to create a snapshot version of the release, and finally make release to ship to production.
Makefile Commands
View all makefile commands
make help
List of all current commands:
all Run lint, test and vet
bench Run all benchmarks in the Go application
build Build the lambda function as a compiled application
clean Remove previous builds, test cache, and packaged releases
clean-mods Remove all the Go mod cache
coverage Shows the test coverage
create-secret Creates an secret into AWS SecretsManager
decrypt Encrypts data using a KMY Key ID
deploy Build, prepare and deploy
encrypt Encrypts data using a KMY Key ID
godocs Sync the latest tag with GoDocs
help Show all commands available
lambda Build a compiled version to deploy to Lambda
lint Run the Go lint application
package Process the CF template and prepare for deployment
release Full production release (creates release in Github)
release-test Full production test release (everything except deploy)
release-snap Test the full release (build binaries)
run Fires the lambda function (IE: run event=started)
save-param Saves a plain-text string parameter in SSM
save-param-encrypted Saves an encrypted string value as a parameter in SSM
save-token Helper for saving a new Github token to Secrets Manager
tag Generate a new tag and push (IE: tag version=0.0.0)
tag-remove Remove a tag if found (IE: tag-remove version=0.0.0)
tag-update Update an existing tag to current commit (IE: tag-update version=0.0.0)
teardown Deletes the entire stack
test Runs vet, lint and ALL tests
test-short Runs vet, lint and tests (excludes integration tests)
test-travis Runs tests via Travis (also exports coverage)
update Update all project dependencies
update-releaser Update the goreleaser application
update-secret Updates an existing secret in AWS SecretsManager
vet Run the Go vet application
Examples & Tests
All unit tests run via Travis CI and uses Go version 1.14.x. View the deployment configuration file.
Run all tests (including integration tests)
make test
Code Standards
Read more about this Go project's code standards.
Maintainers
 |
|---|
| MrZ |
Contributing
View the contributing guidelines and follow the code of conduct.
Support the development of this project 🙏
Credits
This application would not be possible without the work provided in these repositories:
- CPLiakas's SAM Golang Example
- InfoPark's Github Status
- Jenseickmeyer's Commit Status Bot
- Rowanu's SAM Golang Starter
License
Documentation
Source Files