https://github.com/cludden/tf-github-webhooks
a terraform module that deploys webhook endpoint that publishes github events to sns
https://github.com/cludden/tf-github-webhooks
Last synced: about 2 months ago
JSON representation
a terraform module that deploys webhook endpoint that publishes github events to sns
- Host: GitHub
- URL: https://github.com/cludden/tf-github-webhooks
- Owner: cludden
- Created: 2017-10-11T20:49:36.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-27T22:36:10.000Z (almost 7 years ago)
- Last Synced: 2025-02-14T10:17:59.573Z (4 months ago)
- Language: JavaScript
- Size: 191 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# tf-github-webhooks
a `node.js` lambda function that publishes authorized github events to SNS
## Installing
```shell
# clone this repository
$ git clone [email protected]/cludden/tf-github-webhooks.git
# if developing locally
$ cd tf-github-webhooks && nvm use && npm install
```
## Contributing
1. Clone it (`git clone [email protected]:cludden/tf-github-webhooks.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 -am 'feat: adds my new 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
This project uses:
- [docker](https://www.docker.com/) for consistent testing and build environments.
**Prerequisities**:
- [Docker CE & Compose](https://store.docker.com/search?offering=community&type=edition)
**Testing:**
```shell
# run all tests
$ docker-compose run tf-github-webhooks
```
**Linting:**
```shell
# run lint
$ docker-compose run tf-github-webhooks npm run lint
```
**Security:**
```shell
# run security check
$ docker-compose run tf-github-webhooks npm run sec
```
## Building
To build locally:
```shell
$ docker-compose run tf-github-webhooks npm run build
```
## 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-github-webhooks`
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)
## Deploying and Configuring
1. Build the artifact and push to `s3`
1. Use the terraform module
```
module "github_webhooks" {
source = "git::[email protected]:cludden/tf-github-webhooks.git//terraform?ref={version}"
config_parameter_name = "/secrets/tf-github-webhooks"
debug = ""
log_level = "info"
memory_size = 128
name = "github-webhooks"
node_env = "production"
region = "us-west-2"
s3_bucket = "my-artifact-bucket"
s3_key = "path/to/my/artifact.zip"
timeout = 10
}
```
## LICENSE
Licensed under the [MIT License](LICENSE.md)
Copyright (c) 2017 Chris Ludden