gitlab-org--gitlab-foss/doc/user/project/integrations/github.md

GitHub project integration [PREMIUM]

Introduced in GitLab Premium 10.6.

GitLab provides an integration for updating the pipeline statuses on GitHub. This is especially useful if using GitLab for CI/CD only.

This project integration is separate from the instance wide GitHub integration and is automatically configured on GitHub import.

Configuration

Complete these steps on GitHub

This integration requires a GitHub API token with repo:status access granted:

1. Go to your "Personal access tokens" page at https://github.com/settings/tokens
2. Click "Generate New Token"
3. Ensure that repo:status is checked and click "Generate token"
4. Copy the generated token to use on GitLab

Complete these steps on GitLab

1. Navigate to the project you want to configure.
2. Navigate to the Integrations page
3. Click "GitHub".
4. Select the "Active" checkbox.
5. Paste the token you've generated on GitHub
6. Enter the path to your project on GitHub, such as https://github.com/username/repository
7. Optionally check "Static status check names" checkbox to enable static status check names.
8. Save or optionally click "Test Settings".

Static / dynamic status check names

Since GitLab 11.5 it is possible to opt-in to using static status check names.

This makes it possible to mark these status checks as Required on GitHub. If you check "Static status check names" checkbox on the integration page, your GitLab instance host name is going to be appended to a status check name, whereas in case of dynamic status check names, a branch name is going to be appended.

Dynamic status check name is a default behavior.