diff options
Diffstat (limited to 'doc/ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md')
| -rw-r--r-- | doc/ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md | 132 |
1 files changed, 69 insertions, 63 deletions
diff --git a/doc/ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md b/doc/ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md index 1859328247b..b6706c2a272 100644 --- a/doc/ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md +++ b/doc/ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md @@ -19,21 +19,18 @@ Merging now could introduce breaking changes. *Merge trains* can prevent this from happening. A merge train is a queued list of merge requests, each waiting to be merged into the target branch. -Each merge request on the train runs the merged results pipeline immediately before its -changes are merged into the target branch. If the pipeline fails, the breaking changes are -not merged, and the target branch is unaffected. +Many merge requests can be added to the train. Each merge request runs its own merged results pipeline, +which includes the changes from all of the other merge requests in *front* of it on the train. +All the pipelines run in parallel, to save time. -Many merge requests can be added to the train. Each is trying to merge into the target branch. -Each request runs its own merged results pipeline, which includes the changes from -all of the other merge requests in *front* of it on the train. All the pipelines run -in parallel, to save time. +If the pipeline for a merge request fails, the breaking changes are not merged, and the target +branch is unaffected. The merge request is removed from the train, and all pipelines behind it restart. If the pipeline for the merge request at the front of the train completes successfully, -the changes are merged into the target branch, and the other pipelines will continue to +the changes are merged into the target branch, and the other pipelines continue to run. -If one of the pipelines fails, it is removed from the train, and all pipelines behind -it restart, but without the changes that were removed. +## Merge train example Three merge requests (`A`, `B` and `C`) are added to a merge train in order, which creates three merged results pipelines that run in parallel: @@ -50,85 +47,99 @@ to run. If more merge requests are added to the train, they will now include the changes that are included in the target branch, and the `C` changes that are from the merge request already in the train. -Learn more about +Read more about [how merge trains keep your master green](https://about.gitlab.com/blog/2020/01/30/all-aboard-merge-trains/). +<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> +Watch this video for a demonstration on [how parallel execution +of Merge Trains can prevent commits from breaking the default +branch](https://www.youtube.com/watch?v=D4qCqXgZkHQ). + ## Requirements and limitations Merge trains have the following requirements and limitations: +- Merge trains require [GitLab Runner](https://gitlab.com/gitlab-org/gitlab-runner) 11.9 or newer. - GitLab 12.0 and later requires [Redis](https://redis.io/) 3.2 or higher. -- [Pipelines for merged results](../index.md#pipelines-for-merged-results-premium) must be - **configured properly**. - Each merge train can run a maximum of **twenty** pipelines in parallel. If more than twenty merge requests are added to the merge train, the merge requests will be queued until a slot in the merge train is free. There is no limit to the number of merge requests that can be queued. -<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> -Watch this video for a demonstration on [how parallel execution -of Merge Trains can prevent commits from breaking the default -branch](https://www.youtube.com/watch?v=D4qCqXgZkHQ). +## Enable merge trains -## How to add a merge request to a merge train +To enable merge trains for your project: -To add a merge request to a merge train: +1. If you are on a self-managed GitLab instance, ensure the [feature flag](#merge-trains-feature-flag-premium-only) is set correctly. +1. [Configure your CI/CD configuration file](../../index.md#configuring-pipelines-for-merge-requests) + so that the pipeline or individual jobs run for merge requests. +1. Visit your project's **Settings > General** and expand **Merge requests**. +1. Check **Merge pipelines will try to validate the post-merge result prior to merging**. +1. Click **Save changes**. + +CAUTION: **Caution:** +If you select the check box but don't configure your CI/CD to use +pipelines for merge requests, your merge requests may become stuck in an +unresolved state or your pipelines may be dropped. + +## Start a merge train + +To start a merge train: 1. Visit a merge request. -1. Click the **Start/Add to merge train** button. +1. Click the **Start merge train** button.  -## How to remove a merge request from a merge train +Other merge requests can now be added to the train. + +## Add a merge request to a merge train + +To add a merge request to a merge train: 1. Visit a merge request. -1. Click the **Remove from merge train** button. +1. Click the **Add to merge train** button. - +If pipelines are already running for the merge request, you cannot add the merge request +to the train. Instead, you can schedule to add the merge request to a merge train **when the latest +pipeline succeeds**. -## How to view a merge request's current position on the merge train + -After a merge request has been added to the merge train, the merge request's -current position will be displayed under the pipeline widget: +## Remove a merge request from a merge train - +1. Visit a merge request. +1. Click the **Remove from merge train** button. -## Start/Add to merge train when pipeline succeeds + -You can add a merge request to a merge train only when the latest pipeline in the -merge request is finished. While the pipeline is running or pending, you cannot add -the merge request to a train because the current change of the merge request may -be broken thus it could affect the following merge requests. +If you want to add the merge request to a merge train again later, you can. -In this case, you can schedule to add the merge request to a merge train **when the latest -pipeline succeeds** (This pipeline is [Pipelines for merged results](../index.md), not Pipelines for merge train). -You can see the following button instead of the regular **Start/Add to merge train** -button while the latest pipeline is running. +## View a merge request's current position on the merge train - +After a merge request has been added to the merge train, the merge request's +current position is displayed under the pipeline widget: + + ## Immediately merge a merge request with a merge train -In the case where you have a high-priority merge request (for example, a critical patch) to be merged urgently, -you can use **Merge Immediately** option for bypassing the merge train. +If you have a high-priority merge request (for example, a critical patch) that must +be merged urgently, you can bypass the merge train by using the **Merge Immediately** option. This is the fastest option to get the change merged into the target branch.  -However, every time you merge a merge request immediately, it could affect the -existing merge train to be reconstructed, specifically, it regenerates expected -merge commits and pipelines. This means, merging immediately essentially wastes -CI resources. Because of these downsides, you will be asked to confirm before -the merge is initiated: - - +CAUTION: **Caution:** +Each time you merge a merge request immediately, the current merge train +is recreated and all pipelines restart. ## Troubleshooting ### Merge request dropped from the merge train immediately If a merge request is not mergeable (for example, it's WIP, there is a merge -conflict, etc), your merge request will be dropped from the merge train automatically. +conflict, etc.), your merge request will be dropped from the merge train automatically. In these cases, the reason for dropping the merge request is in the **system notes**. @@ -146,35 +157,30 @@ To check the reason: ### Merge When Pipeline Succeeds cannot be chosen [Merge When Pipeline Succeeds](../../../../user/project/merge_requests/merge_when_pipeline_succeeds.md) -is unavailable when -[Pipelines for Merged Results is enabled](../index.md#enabling-pipelines-for-merged-results). +is currently unavailable when Merge Trains are enabled. -Follow [this issue](https://gitlab.com/gitlab-org/gitlab/issues/12267) to -track progress on this issue. +See [the related issue](https://gitlab.com/gitlab-org/gitlab/issues/12267) +for more information. ### Merge Train Pipeline cannot be retried A Merge Train pipeline cannot be retried because the merge request is dropped from the merge train upon failure. For this reason, the retry button does not appear next to the pipeline icon. -In the case of pipeline failure, you should [re-enqueue](#how-to-add-a-merge-request-to-a-merge-train) the merge request to the merge train, which will then initiate a new pipeline. - -### Merge Train disturbs your workflow +In the case of pipeline failure, you should [re-enqueue](#add-a-merge-request-to-a-merge-train) the merge request to the merge train, which will then initiate a new pipeline. -First of all, please check if [merge immediately](#immediately-merge-a-merge-request-with-a-merge-train) -is available as a workaround in your workflow. This is the most recommended -workaround you'd be able to take immediately. If it's not available or acceptable, -please read through this section. +### Merge Trains feature flag **(PREMIUM ONLY)** -Merge train is enabled by default when you enable [Pipelines for merged results](../index.md), -however, you can disable this feature by setting the `:disable_merge_trains` feature flag to `enable`. -When you disable this feature, all existing merge trains are aborted and -the **Start/Add Merge Train** button no longer appears in merge requests. +To enable and disable the Merge Trains feature, use the `:disable_merge_trains` feature flag. To check if the feature flag is enabled on your GitLab instance, -please ask an administrator to execute the following commands **(CORE ONLY)**: +ask an administrator to execute the following commands: ```shell > sudo gitlab-rails console # Login to Rails console of GitLab instance. > Feature.enabled?(:disable_merge_trains) # Check if it's disabled or not. > Feature.enable(:disable_merge_trains) # Disable Merge Trains. +> Feature.disable(:disable_merge_trains) # Enable Merge Trains. ``` + +When you disable this feature, all existing merge trains are cancelled and +the **Start/Add to Merge Train** button no longer appears in merge requests. |