debian-mirror-gitlab/doc/user/project/integrations/github.md

51 lines
2.4 KiB
Markdown
Raw Normal View History

2019-09-30 21:07:59 +05:30
# GitHub project integration **(PREMIUM)**
2019-07-31 22:56:46 +05:30
2019-12-04 20:38:33 +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.
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).
![Pipeline status update on GitHub](img/github_status_check_pipeline_update.png)
## Configuration
### Complete these steps on GitHub
2020-03-13 15:44:24 +05:30
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)
2019-07-31 22:56:46 +05:30
with `repo:status` access granted:
2019-09-30 21:07:59 +05:30
1. Go to your "Personal access tokens" page at <https://github.com/settings/tokens>
2019-07-31 22:56:46 +05:30
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](project_services.md#accessing-the-project-services)
1. Click "GitHub".
1. Select the "Active" checkbox.
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`
2019-12-04 20:38:33 +05:30
1. Optionally uncheck **Static status check names** checkbox to disable static status check names.
2019-07-31 22:56:46 +05:30
1. Save or optionally click "Test Settings".
2020-01-01 13:55:28 +05:30
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.
2019-07-31 22:56:46 +05:30
#### Static / dynamic status check names
2019-12-04 20:38:33 +05:30
> - 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.
2019-07-31 22:56:46 +05:30
This makes it possible to mark these status checks as _Required_ on GitHub.
2019-12-04 20:38:33 +05:30
With **Static status check names** enabled on the integration page, your
2019-07-31 22:56:46 +05:30
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.
![Configure GitHub Project Integration](img/github_configuration.png)