50 lines
2.4 KiB
Markdown
50 lines
2.4 KiB
Markdown
# GitHub project integration **(PREMIUM)**
|
|
|
|
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3836) 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](../import/github.md#mirroring-and-pipeline-status-sharing)
|
|
and is automatically configured on [GitHub import](../../../integration/github.md).
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
### Complete these steps on GitHub
|
|
|
|
This integration requires a [GitHub API token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)
|
|
with `repo:status` access granted:
|
|
|
|
1. Go to your "Personal access tokens" page at <https://github.com/settings/tokens>
|
|
1. Click "Generate New Token"
|
|
1. Ensure that `repo:status` is checked and click "Generate token"
|
|
1. Copy the generated token to use on GitLab
|
|
|
|
### Complete these steps on GitLab
|
|
|
|
1. Navigate to the project you want to configure.
|
|
1. Navigate to the [Integrations page](overview.md#accessing-integrations)
|
|
1. Click "GitHub".
|
|
1. Ensure that the **Active** toggle is enabled.
|
|
1. Paste the token you've generated on GitHub
|
|
1. Enter the path to your project on GitHub, such as `https://github.com/username/repository`
|
|
1. Optionally uncheck **Static status check names** checkbox to disable static status check names.
|
|
1. Save or optionally click "Test Settings".
|
|
|
|
Once the integration is configured, see [Pipelines for external pull requests](../../../ci/ci_cd_for_external_repos/#pipelines-for-external-pull-requests)
|
|
to configure pipelines to run for open pull requests.
|
|
|
|
#### Static / dynamic status check names
|
|
|
|
> - Introduced in GitLab 11.5: using static status check names as opt-in option.
|
|
> - [In GitLab 12.4](https://gitlab.com/gitlab-org/gitlab/-/issues/9931), static status check names is default behavior for new projects.
|
|
|
|
This makes it possible to mark these status checks as _Required_ on GitHub.
|
|
With **Static status check names** enabled 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.
|
|
|
|
|