GitHub Handler 

The GitHub Handler processes GitHub hook events each time a pull request is created or updated. It then triggers builds through the Container Manager. The GitHub Handler also sends commit status updates back to GitHub.

It is implemented as a plugin of the Probo repository. There is also a Bitbucket plugin that is in a separate repository and it’s function and configuration is discussed in a different documentation entry as there are conditions and parameters outside the scope of this document which must be taken into consideration before you can successfully run Bitbucket.

cd probo
npm install

Create a file ggh.yaml with the following contents:

# Port for the server to listen on
port: 3010

# Github hook and credentials
githubWebhookPath: '/github-webhook'

# Container Manager API server
  url: "http://localhost:3020"

Of the defaults above, githubAPIToken must be set to your token. You can generate a personal token at []. A token created from an OAuth flow will also work here. Probo requires the response.

The githubWebhookSecret value should be modified to a secure string as well. This is a random token containing a string value that you select and will need to be used when you configure your webhook in GitHub.


node ./bin/probo github-handler -c ghh.yaml > /dev/null &

Now add a webhook for your repository in GitHub to your server under Settings -> Webhooks & services. Direct link to the configuration page:

Set the following properties:
Payload URL: http://{YOUR-DOMAIN}:3010/github-webhook
Secret: {The value from githubWebhookSecret in the config file}

Next, under “Which events would you like to trigger this webhook?”, select “Let me select individual events”, and select “Pull Request” If you see a green checkmark next to your new webhook, you’re all set. GitHub can successfully send requests to your handler.

<< Container Manager Bitbucket Handler >>