@nodejs-github-bot's heart and soul
The Node.js Foundation members use 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.
Please do, contributions are more than welcome! See CONTRIBUTING.md.
https://ci.nodejs.org/user//configure, by clicking the "show API token" button. Also See: https://wiki.jenkins-ci.org/display/JENKINS/Authenticating+scripted+clients
Build Triggers -> Trigger builds remotely (e.g., from scripts).
10if not set.
The bot will try to load a
.envfile at the root of the project if it exists to set environment varaibles. You will need to create one similar to this:
Note the additional
SSE_RELAYvariable: 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_RELAYto the url of a SSE relay server that will send the GitHub events via Server Sent Events instead. Another option is to use ngrok.
You can use the TestOrgPleaseIgnore GitHub Organization, to test your changes. Actions performed on the repos there will be sent to the SSE Relay. If you use your own Organization/Repository, remember to set the webhook Secret to the same value as
hush-hush), and to change the content type to
application/json(default on the GitHub interface is
application/x-www-form-urlencoded, which will not work with the bot).
GITHUB_WEBHOOK_SECRETenvironment variable is not required when using the relay.
Run the bot:
bash $ 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