Merge branch 'docs/new-mr-diff-ci-variables' into 'master'

Add Merge Request diff CI variables

See merge request gitlab-org/gitlab!48764

app/models/ci/pipeline.rb

@@ -775,12 +775,10 @@ module Ci
           variables.append(key: 'CI_MERGE_REQUEST_SOURCE_BRANCH_SHA', value: source_sha.to_s)
           variables.append(key: 'CI_MERGE_REQUEST_TARGET_BRANCH_SHA', value: target_sha.to_s)
 
-          if Feature.enabled?(:ci_mr_diff_variables, project)
-            diff = self.merge_request_diff
-            if diff.present?
-              variables.append(key: 'CI_MERGE_REQUEST_DIFF_ID', value: diff.id.to_s)
-              variables.append(key: 'CI_MERGE_REQUEST_DIFF_BASE_SHA', value: diff.base_commit_sha)
-            end
+          diff = self.merge_request_diff
+          if diff.present?
+            variables.append(key: 'CI_MERGE_REQUEST_DIFF_ID', value: diff.id.to_s)
+            variables.append(key: 'CI_MERGE_REQUEST_DIFF_BASE_SHA', value: diff.base_commit_sha)
           end
 
           variables.concat(merge_request.predefined_variables)

changelogs/unreleased/docs-new-mr-diff-ci-variables.yml

+---
+title: Add Merge Request diff CI variables
+merge_request: 48764
+author: Jonas Hahnfeld
+type: added

config/feature_flags/development/ci_mr_diff_variables.yml

----
-name: ci_mr_diff_variables
-introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/46621
-rollout_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/285468
-milestone: '13.7'
-type: development
-group: group::pipeline authoring
-default_enabled: false

doc/ci/variables/predefined_variables.md

@@ -92,6 +92,8 @@ Kubernetes-specific environment variables are detailed in the
 | `CI_MERGE_REQUEST_TARGET_BRANCH_SHA`          | 11.9   | all    | The HEAD SHA of the target branch of the merge request if [the pipelines are for merge requests](../merge_request_pipelines/index.md). Available only if `only: [merge_requests]` or [`rules`](../yaml/README.md#rules) syntax is used, the merge request is created, and the pipeline is a [merged result pipeline](../merge_request_pipelines/pipelines_for_merged_results/index.md). **(PREMIUM)**   |
 | `CI_MERGE_REQUEST_TITLE`                      | 11.9   | all    | The title of the merge request if [the pipelines are for merge requests](../merge_request_pipelines/index.md). Available only if `only: [merge_requests]` or  [`rules`](../yaml/README.md#rules) syntax is used and the merge request is created.                                                                                                                                                        |
 | `CI_MERGE_REQUEST_EVENT_TYPE`                 | 12.3   | all    | The event type of the merge request, if [the pipelines are for merge requests](../merge_request_pipelines/index.md). Can be `detached`, `merged_result` or `merge_train`. |
+| `CI_MERGE_REQUEST_DIFF_ID`                    | 13.7   | all    | The version of the merge request diff, if [the pipelines are for merge requests](../merge_request_pipelines/index.md). |
+| `CI_MERGE_REQUEST_DIFF_BASE_SHA`              | 13.7   | all    | The base SHA of the merge request diff, if [the pipelines are for merge requests](../merge_request_pipelines/index.md). |
 | `CI_NODE_INDEX`                               | 11.5   | all    | Index of the job in the job set. If the job is not parallelized, this variable is not set.                                                                                                                                                                                                                                                                 |
 | `CI_NODE_TOTAL`                               | 11.5   | all    | Total number of instances of this job running in parallel. If the job is not parallelized, this variable is set to `1`.                                                                                                                                                                                                                                    |
 | `CI_PAGES_DOMAIN`                             | 11.8   | all    | The configured domain that hosts GitLab Pages.                                                                                                                                                                                                                                                                                                             |

spec/models/ci/pipeline_spec.rb

@@ -755,10 +755,6 @@ RSpec.describe Ci::Pipeline, :mailer, factory_default: :keep do
     end
 
     context 'when pipeline is merge request' do
-      before do
-        stub_feature_flags(ci_mr_diff_variables: false)
-      end
-
       let(:pipeline) do
         create(:ci_pipeline, :detached_merge_request_pipeline, merge_request: merge_request)
       end
@@ -799,22 +795,13 @@ RSpec.describe Ci::Pipeline, :mailer, factory_default: :keep do
             'CI_MERGE_REQUEST_MILESTONE' => milestone.title,
             'CI_MERGE_REQUEST_LABELS' => labels.map(&:title).sort.join(','),
             'CI_MERGE_REQUEST_EVENT_TYPE' => 'detached')
-        expect(subject.to_hash.keys).not_to include(
-          %w[CI_MERGE_REQUEST_DIFF_ID
-             CI_MERGE_REQUEST_DIFF_BASE_SHA])
       end
 
-      context 'when feature flag ci_mr_diff_variables is enabled' do
-        before do
-          stub_feature_flags(ci_mr_diff_variables: true)
-        end
-
-        it 'exposes diff variables' do
-          expect(subject.to_hash)
-            .to include(
-              'CI_MERGE_REQUEST_DIFF_ID' => merge_request.merge_request_diff.id.to_s,
-              'CI_MERGE_REQUEST_DIFF_BASE_SHA' => merge_request.merge_request_diff.base_commit_sha)
-        end
+      it 'exposes diff variables' do
+        expect(subject.to_hash)
+          .to include(
+            'CI_MERGE_REQUEST_DIFF_ID' => merge_request.merge_request_diff.id.to_s,
+            'CI_MERGE_REQUEST_DIFF_BASE_SHA' => merge_request.merge_request_diff.base_commit_sha)
       end
 
       context 'without assignee' do
@@ -867,22 +854,13 @@ RSpec.describe Ci::Pipeline, :mailer, factory_default: :keep do
               'CI_MERGE_REQUEST_MILESTONE' => milestone.title,
               'CI_MERGE_REQUEST_LABELS' => labels.map(&:title).sort.join(','),
               'CI_MERGE_REQUEST_EVENT_TYPE' => 'merged_result')
-          expect(subject.to_hash.keys).not_to include(
-            %w[CI_MERGE_REQUEST_DIFF_ID
-               CI_MERGE_REQUEST_DIFF_BASE_SHA])
         end
 
-        context 'when feature flag ci_mr_diff_variables is enabled' do
-          before do
-            stub_feature_flags(ci_mr_diff_variables: true)
-          end
-
-          it 'exposes diff variables' do
-            expect(subject.to_hash)
-              .to include(
-                'CI_MERGE_REQUEST_DIFF_ID' => merge_request.merge_request_diff.id.to_s,
-                'CI_MERGE_REQUEST_DIFF_BASE_SHA' => merge_request.merge_request_diff.base_commit_sha)
-          end
+        it 'exposes diff variables' do
+          expect(subject.to_hash)
+            .to include(
+              'CI_MERGE_REQUEST_DIFF_ID' => merge_request.merge_request_diff.id.to_s,
+              'CI_MERGE_REQUEST_DIFF_BASE_SHA' => merge_request.merge_request_diff.base_commit_sha)
         end
       end
     end