2020-10-24 23:57:45 +05:30
---
2021-10-27 15:23:28 +05:30
stage: Ecosystem
group: Integrations
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-10-24 23:57:45 +05:30
---
2019-09-30 21:07:59 +05:30
# GitHub project integration **(PREMIUM)**
2019-07-31 22:56:46 +05:30
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3836) in GitLab Premium 10.6.
2019-07-31 22:56:46 +05:30
GitLab provides an integration for updating the pipeline statuses on GitHub.
This is especially useful if using GitLab for CI/CD only.
2021-11-11 11:23:49 +05:30
This project integration is separate from the [instance wide GitHub integration ](../import/github.md#mirror-a-repository-and-share-pipeline-status )
2019-07-31 22:56:46 +05:30
and is automatically configured on [GitHub import ](../../../integration/github.md ).
## Configuration
2021-11-18 22:05:49 +05:30
This integration requires a [GitHub API token ](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token )
2021-04-29 21:17:54 +05:30
with `repo:status` access granted.
Complete these steps on GitHub:
2019-07-31 22:56:46 +05:30
2021-04-29 21:17:54 +05:30
1. Go to your **Personal access tokens** page at < https: // github . com / settings / tokens > .
1. Select **Generate new token** .
1. Under **Note** , enter a name for the new token.
1. Ensure that `repo:status` is checked and select **Generate token** .
1. Copy the generated token to use in GitLab.
2019-07-31 22:56:46 +05:30
2021-04-29 21:17:54 +05:30
Complete these steps in GitLab:
2019-07-31 22:56:46 +05:30
2021-04-29 21:17:54 +05:30
1. Go to the project you want to configure.
1. Go to the [Integrations page ](overview.md#accessing-integrations )
1. Select **GitHub** .
2020-04-22 19:07:51 +05:30
1. Ensure that the **Active** toggle is enabled.
2021-04-29 21:17:54 +05:30
1. Paste the token you generated on GitHub.
1. Enter the path to your project on GitHub, such as `https://github.com/username/repository` .
2021-12-11 22:18:48 +05:30
1. (Optional) To disable static status check names, clear the **Enable static status check names** checkbox.
2021-04-29 21:17:54 +05:30
1. Select **Save changes** or optionally select **Test settings** .
2019-07-31 22:56:46 +05:30
2021-04-29 21:17:54 +05:30
After configuring the integration, see [Pipelines for external pull requests ](../../../ci/ci_cd_for_external_repos/#pipelines-for-external-pull-requests )
2020-01-01 13:55:28 +05:30
to configure pipelines to run for open pull requests.
2021-12-11 22:18:48 +05:30
### Static or dynamic status check names
2019-07-31 22:56:46 +05:30
2019-12-04 20:38:33 +05:30
> - Introduced in GitLab 11.5: using static status check names as opt-in option.
2020-06-23 00:09:42 +05:30
> - [In GitLab 12.4](https://gitlab.com/gitlab-org/gitlab/-/issues/9931), static status check names is default behavior for new projects.
2019-07-31 22:56:46 +05:30
2021-04-29 21:17:54 +05:30
This makes it possible to mark these status checks as **Required** on GitHub.
2021-12-11 22:18:48 +05:30
When **Enable static status check names** is checked on the integration page, your
2021-04-29 21:17:54 +05:30
GitLab instance host name is appended to a status check name.
2019-07-31 22:56:46 +05:30
2021-12-11 22:18:48 +05:30
When unchecked, it uses dynamic status check names and appends the branch name.
