Run only minimal jobs in fork pipelines

Signed-off-by: Rémy Coutable <remy@rymai.me>

Run only minimal jobs in fork pipelines
Signed-off-by: Rémy Coutable <remy@rymai.me>
c4c79816 · Rémy Coutable · Albert Salim · e347efe8 · c4c79816 · c4c79816
Commit c4c79816 authored Jan 20, 2022 by Rémy Coutable Committed by Albert Salim Feb 16, 2022
Hide whitespace changes
Inline Side-by-side

Showing with 71 additions and 4 deletions

.gitlab/ci/rules.gitlab-ci.yml .gitlab/ci/rules.gitlab-ci.yml +60 -4

doc/development/pipelines.md doc/development/pipelines.md +11 -0

No files found.
--- a/.gitlab/ci/rules.gitlab-ci.yml
+++ b/.gitlab/ci/rules.gitlab-ci.yml
@@ -73,6 +73,9 @@
 .if-security-merge-request: &if-security-merge-request
  if: '$CI_PROJECT_NAMESPACE == "gitlab-org/security" && $CI_MERGE_REQUEST_IID'

+.if-fork-merge-request: &if-fork-merge-request
+  if: '$CI_PROJECT_NAMESPACE !~ /^gitlab(-org)?($|\/)/ && $CI_MERGE_REQUEST_IID && $CI_MERGE_REQUEST_LABELS !~ /pipeline:run-all-rspec/'
+
 .if-default-branch-schedule-2-hourly: &if-default-branch-schedule-2-hourly
  if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_PIPELINE_SOURCE == "schedule" && $FREQUENCY == "2-hourly"'

@@ -731,6 +734,8 @@

 .frontend:rules:jest:
  rules:
+    - <<: *if-fork-merge-request
+      when: never
    - <<: *if-merge-request-labels-run-all-jest
    - <<: *if-default-refs
      changes: *core-frontend-patterns
@@ -747,11 +752,12 @@

 .frontend:rules:jest:minimal:
  rules:
+    - <<: *if-fork-merge-request
+      changes: *code-backstage-patterns
    - !reference [".rails:rules:minimal-default-rules", rules]
    - <<: *if-merge-request-labels-run-all-jest
      when: never
-    - <<: *if-default-refs
-      changes: *core-frontend-patterns
+    - changes: *core-frontend-patterns
      when: never
    - <<: *if-merge-request
      changes: *ci-patterns
@@ -882,11 +888,15 @@

 .rails:rules:ee-and-foss-migration:
  rules:
+    - <<: *if-fork-merge-request
+      when: never
    - <<: *if-merge-request-labels-run-all-rspec
    - <<: *if-merge-request
      changes: *core-backend-patterns
    - <<: *if-merge-request
      changes: *ci-patterns
+    # When DB schema changes, many migrations spec may be affected. However, the test mapping from Crystalball does not map db change to a specific migration spec well.
+    # See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68840.
    - <<: *if-merge-request
      changes: *db-patterns
    - <<: *if-automated-merge-request
@@ -899,8 +909,12 @@

 .rails:rules:ee-and-foss-migration:minimal:
  rules:
+    - <<: *if-fork-merge-request
+      changes: *db-patterns
    - !reference [".rails:rules:minimal-default-rules", rules]
    - !reference [".rails:rules:unit-integration:minimal-default-rules", rules]
+    # When DB schema changes, many migrations spec may be affected. However, the test mapping from Crystalball does not map db change to a specific migration spec well.
+    # See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68840.
    - <<: *if-merge-request
      changes: *db-patterns
      when: never
@@ -921,11 +935,15 @@

 .rails:rules:ee-and-foss-unit:
  rules:
+    - <<: *if-fork-merge-request
+      when: never
    - !reference [".rails:rules:ee-and-foss-default-rules", rules]
    - changes: *backend-patterns

 .rails:rules:ee-and-foss-unit:minimal:
  rules:
+    - <<: *if-fork-merge-request
+      changes: *backend-patterns
    - !reference [".rails:rules:minimal-default-rules", rules]
    - !reference [".rails:rules:unit-integration:minimal-default-rules", rules]
    - <<: *if-merge-request
@@ -933,11 +951,15 @@

 .rails:rules:ee-and-foss-integration:
  rules:
+    - <<: *if-fork-merge-request
+      when: never
    - !reference [".rails:rules:ee-and-foss-default-rules", rules]
    - changes: *backend-patterns

 .rails:rules:ee-and-foss-integration:minimal:
  rules:
+    - <<: *if-fork-merge-request
+      changes: *backend-patterns
    - !reference [".rails:rules:minimal-default-rules", rules]
    - !reference [".rails:rules:unit-integration:minimal-default-rules", rules]
    - <<: *if-merge-request
@@ -945,11 +967,15 @@

 .rails:rules:ee-and-foss-system:
  rules:
+    - <<: *if-fork-merge-request
+      when: never
    - !reference [".rails:rules:system-default-rules", rules]
    - changes: *code-backstage-patterns

 .rails:rules:ee-and-foss-system:minimal:
  rules:
+    - <<: *if-fork-merge-request
+      changes: *code-backstage-patterns
    - !reference [".rails:rules:minimal-default-rules", rules]
    - !reference [".rails:rules:system:minimal-default-rules", rules]

@@ -976,6 +1002,8 @@
      changes: *core-backend-patterns
    - <<: *if-merge-request
      changes: *ci-patterns
+    # When DB schema changes, many migrations spec may be affected. However, the test mapping from Crystalball does not map db change to a specific migration spec well.
+    # See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68840.
    - <<: *if-merge-request
      changes: *db-patterns
    - <<: *if-automated-merge-request
@@ -992,6 +1020,8 @@
      when: never
    - !reference [".rails:rules:minimal-default-rules", rules]
    - !reference [".rails:rules:unit-integration:minimal-default-rules", rules]
+    # When DB schema changes, many migrations spec may be affected. However, the test mapping from Crystalball does not map db change to a specific migration spec well.
+    # See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68840.
    - <<: *if-merge-request
      changes: *db-patterns
      when: never
@@ -1000,6 +1030,8 @@
  rules:
    - <<: *if-not-ee
      when: never
+    - <<: *if-fork-merge-request
+      when: never
    - !reference [".rails:rules:ee-and-foss-default-rules", rules]
    - changes: *backend-patterns

@@ -1007,6 +1039,8 @@
  rules:
    - <<: *if-not-ee
      when: never
+    - <<: *if-fork-merge-request
+      changes: *backend-patterns
    - !reference [".rails:rules:minimal-default-rules", rules]
    - !reference [".rails:rules:unit-integration:minimal-default-rules", rules]
    - <<: *if-merge-request
@@ -1016,6 +1050,8 @@
  rules:
    - <<: *if-not-ee
      when: never
+    - <<: *if-fork-merge-request
+      when: never
    - !reference [".rails:rules:ee-and-foss-default-rules", rules]
    - changes: *backend-patterns

@@ -1023,6 +1059,8 @@
  rules:
    - <<: *if-not-ee
      when: never
+    - <<: *if-fork-merge-request
+      changes: *backend-patterns
    - !reference [".rails:rules:minimal-default-rules", rules]
    - !reference [".rails:rules:unit-integration:minimal-default-rules", rules]
    - <<: *if-merge-request
@@ -1032,6 +1070,8 @@
  rules:
    - <<: *if-not-ee
      when: never
+    - <<: *if-fork-merge-request
+      when: never
    - !reference [".rails:rules:system-default-rules", rules]
    - changes: *code-backstage-patterns

@@ -1039,6 +1079,8 @@
  rules:
    - <<: *if-not-ee
      when: never
+    - <<: *if-fork-merge-request
+      changes: *code-backstage-patterns
    - !reference [".rails:rules:minimal-default-rules", rules]
    - !reference [".rails:rules:system:minimal-default-rules", rules]

@@ -1051,8 +1093,8 @@
      changes: *core-backend-patterns
    - <<: *if-merge-request
      changes: *ci-patterns
-    - <<: *if-security-merge-request
-      changes: *db-patterns
+    # When DB schema changes, many migrations spec may be affected. However, the test mapping from Crystalball does not map db change to a specific migration spec well.
+    # See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68840.
    - <<: *if-merge-request-labels-as-if-foss
      changes: *db-patterns
    - <<: *if-automated-merge-request
@@ -1068,6 +1110,8 @@
      when: never
    - !reference [".rails:rules:minimal-default-rules", rules]
    - !reference [".rails:rules:as-if-foss-migration-unit-integration:minimal-default-rules", rules]
+    # When DB schema changes, many migrations spec may be affected. However, the test mapping from Crystalball does not map db change to a specific migration spec well.
+    # See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68840.
    - <<: *if-merge-request-labels-as-if-foss
      changes: *db-patterns
      when: never
@@ -1076,6 +1120,8 @@
  rules:
    - <<: *if-not-ee
      when: never
+    - <<: *if-fork-merge-request
+      when: never
    - !reference [".rails:rules:ee-and-foss-default-rules", rules]
    - <<: *if-merge-request-labels-as-if-foss
      changes: *backend-patterns
@@ -1084,6 +1130,8 @@
  rules:
    - <<: *if-not-ee
      when: never
+    - <<: *if-fork-merge-request
+      when: never
    - !reference [".rails:rules:minimal-default-rules", rules]
    - !reference [".rails:rules:as-if-foss-migration-unit-integration:minimal-default-rules", rules]
    - <<: *if-merge-request-labels-as-if-foss
@@ -1093,6 +1141,8 @@
  rules:
    - <<: *if-not-ee
      when: never
+    - <<: *if-fork-merge-request
+      when: never
    - !reference [".rails:rules:ee-and-foss-default-rules", rules]
    - <<: *if-merge-request-labels-as-if-foss
      changes: *backend-patterns
@@ -1101,6 +1151,8 @@
  rules:
    - <<: *if-not-ee
      when: never
+    - <<: *if-fork-merge-request
+      when: never
    - !reference [".rails:rules:minimal-default-rules", rules]
    - !reference [".rails:rules:as-if-foss-migration-unit-integration:minimal-default-rules", rules]
    - <<: *if-merge-request-labels-as-if-foss
@@ -1110,6 +1162,8 @@
  rules:
    - <<: *if-not-ee
      when: never
+    - <<: *if-fork-merge-request
+      when: never
    - !reference [".rails:rules:system-default-rules", rules]
    - <<: *if-merge-request-labels-as-if-foss
      changes: *code-backstage-patterns
@@ -1118,6 +1172,8 @@
  rules:
    - <<: *if-not-ee
      when: never
+    - <<: *if-fork-merge-request
+      when: never
    - !reference [".rails:rules:minimal-default-rules", rules]
    - <<: *if-merge-request
      changes: *core-backend-patterns

--- a/doc/development/pipelines.md
+++ b/doc/development/pipelines.md
@@ -90,6 +90,13 @@ In addition, there are a few circumstances where we would always run the full Je
 - when any vendored JavaScript file is changed (i.e. `vendor/assets/javascripts/**/*`)
 - when any backend file is changed ([see the patterns list for details](https://gitlab.com/gitlab-org/gitlab/-/blob/3616946936c1adbd9e754c1bd06f86ba670796d8/.gitlab/ci/rules.gitlab-ci.yml#L205-216))

+### Fork pipelines
+
+We only run the minimal RSpec & Jest jobs for fork pipelines unless the `pipeline:run-all-rspec`
+label is set on the MR. The goal is to reduce the CI minutes consumed by fork pipelines.
+
+See the [experiment issue](https://gitlab.com/gitlab-org/quality/team-tasks/-/issues/1170).
+
 ## Fail-fast job in merge request pipelines

 To provide faster feedback when a merge request breaks existing tests, we are experimenting with a
@@ -176,6 +183,8 @@ Tests that are [known to be flaky](testing_guide/flaky_tests.md#automatic-retrie
 skipped unless the `$SKIP_FLAKY_TESTS_AUTOMATICALLY` variable is set to `false` or if the `~"pipeline:run-flaky-tests"`
 label is set on the MR.

+See the [experiment issue](https://gitlab.com/gitlab-org/quality/team-tasks/-/issues/1069).
+
 #### Automatic retry of failing tests in a separate process

 When the `$RETRY_FAILED_TESTS_IN_NEW_PROCESS` variable is set to `true`, RSpec tests that failed are automatically retried once in a separate
@@ -183,6 +192,8 @@ RSpec process. The goal is to get rid of most side-effects from previous tests t

 We keep track of retried tests in the `$RETRIED_TESTS_REPORT_FILE` file saved as artifact by the `rspec:flaky-tests-report` job.

+See the [experiment issue](https://gitlab.com/gitlab-org/quality/team-tasks/-/issues/1148).
+
 ### Monitoring

 The GitLab test suite is [monitored](performance.md#rspec-profiling) for the `main` branch, and any branch