mc-ext-github

v0.0.1
Mission Control Extension for working with GitHub, including cloning repos, handling webhooks, and the status API.

Mission Control GitHub Extension

Build Status

This is an extension for Mission Control to use GitHub webhooks, and other features (in the future).

Setup

Add GITHUB_WEBHOOK_SECRET=a_securely_generated_random_string (and input a random key which will be used later to configure webhooks)

A quick method for generating an alphanumeric string:

openssl rand -hex 24

Configuring a webhook with GitHub

  1. Go to your repository on GitHub.

  2. Click on "Settings".

  3. Click on "Webhooks & services"

  4. Click on Add Webhook

    adding a webhook

  5. Enter the URL of your Mission Control with the extension webhook endpoint included http://your-host-name/ext/mc/github/webhooks/execute-pipeline/1234. Replace 1234 with your pipeline configuration id to trigger. (Note: It is highly recommended to use HTTPS.)

  6. Enter the GITHUB_WEBHOOK_SECRET from your .env file.

  7. Choose "Let me select individual events".

  8. Check the events that you want to trigger a build. You may want to check "push" and "pull request".

    configuring a webhook

  9. Click "Add webhook"

npm i mc-ext-github

Metadata

  • MIT
  • Whatever
  • Unknown
  • released 1/14/2016

Downloads

Maintainers