debian-mirror-gitlab/doc/ci/ci_cd_for_external_repos/index.md

99 lines
3.8 KiB
Markdown
Raw Normal View History

2019-09-04 21:01:54 +05:30
---
2020-06-23 00:09:42 +05:30
stage: Verify
group: Continuous Integration
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
2019-09-04 21:01:54 +05:30
type: index, howto
---
2019-09-30 21:07:59 +05:30
# GitLab CI/CD for external repositories **(PREMIUM)**
2019-07-31 22:56:46 +05:30
2020-04-22 19:07:51 +05:30
>[Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/4642) in [GitLab Premium](https://about.gitlab.com/pricing/) 10.6.
2019-07-31 22:56:46 +05:30
2019-09-04 21:01:54 +05:30
GitLab CI/CD can be used with:
- [GitHub](github_integration.md).
- [Bitbucket Cloud](bitbucket_integration.md).
- Any other Git server.
2019-07-31 22:56:46 +05:30
Instead of moving your entire project to GitLab, you can connect your
external repository to get the benefits of GitLab CI/CD.
2021-02-22 17:27:13 +05:30
Connecting an external repository sets up [repository mirroring](../../user/project/repository/repository_mirroring.md)
2019-12-26 22:10:19 +05:30
and create a lightweight project with issues, merge requests, wiki, and
2019-07-31 22:56:46 +05:30
snippets disabled. These features
2020-04-22 19:07:51 +05:30
[can be re-enabled later](../../user/project/settings/index.md#sharing-and-permissions).
2019-07-31 22:56:46 +05:30
2019-09-04 21:01:54 +05:30
To connect to an external repository:
1. From your GitLab dashboard, click **New project**.
2021-02-22 17:27:13 +05:30
1. Switch to the **CI/CD for external repository** tab.
2019-09-04 21:01:54 +05:30
1. Choose **GitHub** or **Repo by URL**.
1. The next steps are similar to the [import flow](../../user/project/import/index.md).
2019-07-31 22:56:46 +05:30
![CI/CD for external repository project creation](img/ci_cd_for_external_repo.png)
2019-12-04 20:38:33 +05:30
## Pipelines for external pull requests
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/65139) in GitLab Premium 12.3.
2019-12-04 20:38:33 +05:30
When using GitLab CI/CD with an [external repository on GitHub](github_integration.md),
it's possible to run a pipeline in the context of a Pull Request.
When you push changes to a remote branch in GitHub, GitLab CI/CD can run a pipeline for
the branch. However, when you open or update a Pull Request for that branch you may want to:
- Run extra jobs.
- Not run specific jobs.
For example:
```yaml
always-run:
script: echo 'this should always run'
on-pull-requests:
script: echo 'this should run on pull requests'
only:
- external_pull_requests
except-pull-requests:
script: echo 'this should not run on pull requests'
except:
- external_pull_requests
```
### How it works
When a repository is imported from GitHub, GitLab subscribes to webhooks
for `push` and `pull_request` events. Once a `pull_request` event is received,
the Pull Request data is stored and kept as a reference. If the Pull Request
has just been created, GitLab immediately creates a pipeline for the external
pull request.
If changes are pushed to the branch referenced by the Pull Request and the
Pull Request is still open, a pipeline for the external pull request is
created.
2021-02-22 17:27:13 +05:30
GitLab CI/CD creates 2 pipelines in this case. One for the
2019-12-04 20:38:33 +05:30
branch push and one for the external pull request.
2021-01-29 00:20:46 +05:30
After the Pull Request is closed, no pipelines are created for the external pull
2019-12-04 20:38:33 +05:30
request, even if new changes are pushed to the same branch.
### Additional predefined variables
By using pipelines for external pull requests, GitLab exposes additional
[predefined variables](../variables/predefined_variables.md) to the pipeline jobs.
The variable names are prefixed with `CI_EXTERNAL_PULL_REQUEST_`.
### Limitations
2021-02-22 17:27:13 +05:30
This feature currently does not support Pull Requests from fork repositories. Any Pull Requests from fork repositories are ignored. [Read more](https://gitlab.com/gitlab-org/gitlab/-/issues/5667).
2019-12-04 20:38:33 +05:30
2021-02-22 17:27:13 +05:30
Given that GitLab creates 2 pipelines, if changes are pushed to a remote branch that
references an open Pull Request, both contribute to the status of the Pull Request
2019-12-04 20:38:33 +05:30
via GitHub integration. If you want to exclusively run pipelines on external pull
requests and not on branches you can add `except: [branches]` to the job specs.
2020-06-23 00:09:42 +05:30
[Read more](https://gitlab.com/gitlab-org/gitlab/-/issues/24089#workaround).