github-notify
v0.4.0
Published
Send emails when new GitHub Issues are created for a repo
Downloads
4
Readme
github-notify
Send emails when new GitHub Issues are created for a repo.
Quickstart
$ sudo apt-get install g++ zlib1g zlib1g-dev autoconf
$ npm install github-notify
Edit the config.json
file:
timeout
How often to check for new issues (in minutes).
github.user
A GitHub username or organisation name.
github.repo
A GitHub repository.
github.authenticate
Not required. Follow instructions at node-github.
email.fields
For config of these follow instructions at Nodemailer.
email.smtp
For config of these follow instructions at Nodemailer.
email.template
An object with two Eco templates for building the email. Plaintext is auto-generated from the HTML version.
And finally start it all up:
$ node index.js
There is also a service on /
started on an automatic port or one specified through command line.
##ENV
One can use ENV variables in the config.
Replace the value in the config.json
file with a string that begins with a $
followed by the ENV variable path. The app will recognize that and get the value from the environment. Example:
"$GITHUB_TOKEN"
> process.env.GITHUB_TOKEN
##FYI
The data is stored in a flat file EJDB
database, app reload on PaaS platforms like Heroku will probably wipe your history.