Node.js GitHub Bot

The Node.js Foundation's uses this bot to help manage the repositories of the GitHub organization.

It executes scripts in response to events that are pushed to it via GitHub webhooks. All repositories that use this bot have the same webhook url & secret configured (there is only 1 bot instance). Org-wide webhooks are not allowed.

Contributing

Please do, contributions are more than welcome! See CONTRIBUTING.md.

Environment Variables

GITHUB_TOKEN
The GitHub API token for your account (or bot account) that will be used to make API calls to GitHub. The account must have proper access to perform the actions required by your script.
GITHUB_WEBHOOK_SECRET
The webhook secret that GitHub signs the POSTed payloads with. This is created when the webhook is defined. The default is hush-hush.
TRAVIS_CI_TOKEN
For scripts that communicate with Travis CI. Your Travis token is visible on yourprofile page, by clicking the "show token" link. Also See: https://blog.travis-ci.com/2013-01-28-token-token-token
LOGIN_CREDENTIALS
Username and password used to protected the log files exposed in /logs. Expected format: username:password.
KEEP_LOGS
Number of days to keep rotated log files, defaults to 10 if not set.
LOGS_DIR
Directory where logs should be written and exposed by the /logs endpoint.

Developing Locally

The bot will try to load a .env file at the root of the project if it exists to set environment varaibles. You will need to create one similar to this:

GITHUB_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
TRAVIS_CI_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
SSE_RELAY=https://hook-relay.herokuapp.com

Note the additional SSE_RELAY variable: When developing locally, it is difficult to setup a GitHub webhook pointing to the computer you are developing on. An easy workaround is to set the SSE_RELAY to the url of a SSE relay server that will send the GitHub events via Server Sent Events instead.

You can use the TestOrgPleaseIgnore GitHub Organization, to test your changes. Actions performed on the repos there will be sent to the SSE Relay.

The GITHUB_WEBHOOK_SECRET environment variable is not required when using the relay.

Run the bot:

$ npm start

When developing a script, it is likely that you will only want to run the script(s) that you are working on. You may pass an additional glob argument to specify which scripts to run.

$ SCRIPTS=./scripts/my-new-event-handler.js npm start

License

MIT

License

enterstudio/github-bot

ErrorLooks like something went wrong!

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages