https://github.com/cludden/tf-codebuild-trigger
a node.js lambda function that triggers AWS Codebuild project builds using github event payloads delivered via SNS
https://github.com/cludden/tf-codebuild-trigger
Last synced: 9 months ago
JSON representation
a node.js lambda function that triggers AWS Codebuild project builds using github event payloads delivered via SNS
- Host: GitHub
- URL: https://github.com/cludden/tf-codebuild-trigger
- Owner: cludden
- License: mit
- Created: 2017-11-09T17:08:54.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-27T22:23:10.000Z (over 7 years ago)
- Last Synced: 2025-03-19T22:46:57.667Z (9 months ago)
- Language: JavaScript
- Size: 74.2 KB
- Stars: 3
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# tf-codebuild-trigger
a `node.js` lambda function that trigger `AWS Codebuild` project builds using `Github` event payloads delivered via `SNS`
## Installing
```shell
# clone the repo and install dependencies
$ git clone git@github.com:cludden/tf-codebuild-trigger.git
```
## Contributing
1. Clone it (`git clone git@github.com:cludden/tf-codebuild-trigger.git`)
1. Create your feature branch (`git checkout -b my-new-feature`)
1. Commit your changes using [conventional changelog standards](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md) (`git commit -m 'feat(my-new-feature): Add some feature'`)
1. Push to the branch (`git push origin my-new-feature`)
1. Ensure linting/security/tests are all passing
1. Create new Pull Request
## Testing
Prerequisites:
- [Docker & Compose](https://store.docker.com/search?offering=community&type=edition))
```shell
# run test suite and generate code coverage
$ docker-compose run tf-codebuild-trigger
# run linter
$ docker-compose run tf-codebuild-trigger npm run lint
# run security scan
$ docker-compose run tf-codebuild-trigger npm run sec
```
## Building
```
$ docker-compose run tf-codebuild-trigger
```
## Releasing
1. Merge fixes & features to master
1. Run lint check `npm run lint`
1. Run security check `npm run sec`
1. Run full test suite `docker-compose run tf-codebuild-trigger`
1. Run release script `npm run release`
1. Push release & release tag to github `git push --follow-tags`
1. [Publish new release](https://help.github.com/articles/creating-releases/) in github, using the release notes from the [CHANGELOG](./CHANGELOG)
## Configuring
Define custom configuration
```json
{
"github": {
"buildspecs": {
"buildspec.pr.yml": {
"type": "object",
"properties": {
"eventName": {
"const": "pull_request"
},
"action": {
"type": "string",
"enum": [
"opened",
"edited",
"reopened"
]
}
},
"required": [
"eventName",
"action"
]
},
"buildspec.release.yml": {
"type": "object",
"properties": {
"eventName": {
"const": "release"
},
"action": {
"type": "string",
"enum": [
"published"
]
}
},
"required": [
"eventName",
"action"
]
}
}
},
"log": {
"level": "info"
}
}
```
Add JSON configuration to ssm
```shell
$ aws ssm put-parameter --name /secrets/codebuild-trigger/custom --type SecureString --value $JSONCONFIG
```
## Deploying
Via terraform
```
module "codebuild_trigger" {
source = "git::git@github.com:cludden/tf-codebuild-trigger.git//terraform?ref={version}"
additional_parameter_names = "/secrets/codebuild-trigger/custom"
config_parameter_name = "/secrets/codebuild-trigger"
debug = ""
memory_size = 128
name = "codebuild-trigger"
node_env = "production"
region = "us-west-2"
s3_bucket = "my-artifact-bucet"
s3_key = "tf-codebuild-trigger/${var.version}/index.zip"
sns_topic_arn = "${var.sns_topic_arn}"
timeout = 10
}
```
## License
Licensed under the [MIT License](LICENSE.md)
Copyright (c) 2017 Chris Ludden