This module is a simple Slackbot that post a notification to a Slack group channel when new releases for one of configured GitHub repositories.
Implementation of this module uses rss-slack-integration
npm install github-releases-slack-notifier
Application needs an incoming webhook in your Slack. You can create it here
- Copy your
webhookUrl - Create
config.jsonfile usingconfig.json.template. Example:
{
"webhookUrl": "https://hooks.slack.com/services/yourservicehash",
"icon": ":loudspeaker:",
"interval": 3600
}
- Insert your
webhookUrlinto the config file - Change default
icon(smile code or url) andinterval(seconds) if it is necessary - Create
repos.jsonfile usingrepos.json.template - Add a config object for each repo using example from template.
urlis a required field and the rest fields are optional. Example:
[
{
"url": "https://github.com/jquery/jquery",
"name": "jQuery",
"webhookUrl": "https://hooks.slack.com/services/YourAlternativeServiceHash",
"icon": "https://example.com/icon.png",
"interval": 1800,
"botName" : "jQuery releases"
},
{
"url": "https://github.com/angular/angular"
}
]
- Run
index.json your server
node index
Note: It's recommended to start this application as a backgroud process and setup it to start automatically after server restarting.
If you experience any issues with this module you can submit issues at the project's Github Repository.
Any help towards improving this module is welcome. If you want to add features or fix bugs you are welcome to submit a pull request.
This project is licensed under MIT. See the LICENSE file.