https://github.com/bannzai/notifier
notifier connect to slack when any actions on GitHub
https://github.com/bannzai/notifier
Last synced: 8 months ago
JSON representation
notifier connect to slack when any actions on GitHub
- Host: GitHub
- URL: https://github.com/bannzai/notifier
- Owner: bannzai
- License: mit
- Created: 2019-10-08T10:01:34.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-17T06:28:29.000Z (over 6 years ago)
- Last Synced: 2025-04-06T05:00:01.885Z (about 1 year ago)
- Language: Go
- Homepage:
- Size: 87.9 KB
- Stars: 24
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# notifier
**notifier** connect to Slack when any actions on GitHub
## Install
Install with git clone.
```shell
$ git clone git@github.com:bannzai/notifier.git
```
Or install via go get
```shell
$ go get -u github.com/bannzai/notifier
```
## Deploy
### Settings
#### Service Setting
Setting other services is necessary to run **notifier**.
Look below.
- [Slack Settings Document](https://github.com/bannzai/notifier/tree/master/docs/SLACK_SETTINGS.md)
- [GitHub Settings Document](https://github.com/bannzai/notifier/tree/master/docs/GITHUB_SETTINGS.md)
#### Cooperation ID
**notifier** should define A service id to B service id mapping file format by yaml.
See [documents](https://github.com/bannzai/notifier/tree/master/docs/NOTIFIER_YAML_SETTINGS.md).
### Recommended
notifier prepared heroku configurations.
If you have heroku account and already login, you can exec make heroku command and deploy it.
```
$ make heroku
```
### Other
notifier prepared Deockerfile.
It mean about run on Docker anywhere.
### Environment
notifier is necessary some environment variables
| Key | Description |
| ---- | ---- |
| YAML_FILE_PATH | Yaml file path about relation of user for GitHub and Slack accounts. Bot local file path or remote file path(http or https)|
| NOTIFIER_SLACK_TOKEN | notifier used Slack API Token. See also https://api.slack.com/ |
## LICENSE
**notifiier** is available under the MIT license. See the LICENSE file for more info.