https://github.com/cludden/tf-codebuild-github-status
a node.js lambda function that updates github commit statuses based on codebuild events
https://github.com/cludden/tf-codebuild-github-status
Last synced: 2 months ago
JSON representation
a node.js lambda function that updates github commit statuses based on codebuild events
- Host: GitHub
- URL: https://github.com/cludden/tf-codebuild-github-status
- Owner: cludden
- License: mit
- Created: 2017-11-10T00:14:31.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-08-02T16:43:49.000Z (almost 2 years ago)
- Last Synced: 2025-02-14T10:18:01.738Z (4 months ago)
- Language: JavaScript
- Size: 85.9 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# tf-codebuild-github-status
a `node.js` lambda function that updates `github` PR statuses based on `codebuild` events
## Installing
```shell
# clone the repo and install dependencies
$ git clone [email protected]:cludden/tf-codebuild-github-status.git
```
## Contributing
1. Clone it (`git clone [email protected]:cludden/tf-codebuild-github-status.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-github-status
# run linter
$ docker-compose run tf-codebuild-github-status npm run lint
# run security scan
$ docker-compose run tf-codebuild-github-status npm run sec
```
## Building
```
$ docker-compose run tf-codebuild-github-status
```
## 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-github-status`
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": {
"url": "https://api.github.com",
"owner": "my-org",
"token": "xxxxxxxx"
},
"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::[email protected]:cludden/tf-codebuild-github-status.git//terraform?ref={version}"
config_parameter_name = "/secrets/codebuild-trigger"
debug = ""
memory_size = 128
name = "codebuild-github-status"
node_env = "production"
region = "us-west-2"
s3_bucket = "my-artifact-bucket"
s3_key = "tf-codebuild-github-status/${var.version}/index.zip"
timeout = 10
}
```
## License
Licensed under the [MIT License](LICENSE.md)
Copyright (c) 2017 Chris Ludden