Skip to content
Slipwaydocs

GitHub

Connect GitHub.com organisations and repositories through a GitHub App.

At a glance

Section titled “At a glance”
Category Source control
Authentication GitHub App installation (short-lived installation tokens)
Provider id github

What it does

Section titled “What it does”
  • Webhooks for push, pull_request, tag and release events
  • Commit statuses and checks
  • PR summary comments
  • Deployment statuses
  • Repository browsing for pipeline discovery

Set up

Section titled “Set up”
  1. Open Settings, Integrations, GitHub and choose Install GitHub App.
  2. Select the GitHub organisation and the repositories Slipway may access (you can change this later in GitHub).
  3. Back in Slipway, link a repository to a project. Slipway scans .slipway/*.yaml and slipway.yaml and creates a pipeline for each file.
  4. Push a commit. A run appears in Slipway and a status check appears on the commit.

Configuration

Section titled “Configuration”

Illustrative configuration. Non-secret settings are stored as integration config; credentials are stored as encrypted Slipway secrets and referenced by name.

provider: github
config:
  installation_id: 12345678      # set by the install flow
  repositories: [acme/api, acme/web]

Notes

Section titled “Notes”

The App requests the minimum permissions: read access to code and metadata, read and write on checks, commit statuses, pull requests and deployments. It never needs write access to code.

Section titled “Related”