如何消除使用几乎相同阶段的“.gitlab-ci.yml”脚本中的代码重复？

Question

我有一个 gitlab-ci/cd.yaml 文件可以执行 2 个测试脚本。如您所见，有很多重复发生。事实上，这两个阶段是相同的，除了它们的“脚本”值。

对于烟熏套件，该值为

npm 运行 docker_smoke --single-运行 --progress false

对于回归套件，该值为

npm 运行 docker_regression --single-运行 --progress false

image: node-karma-protractor

stages:
  - suiteSmoke
  - suiteRegression

before_script:
  - npm install

# Smoke suite =================================
smoke_suite:
  stage: suiteSmoke
  tags:
    - docker-in-docker
  cache:
    key: ${CI_COMMIT_REF_SLUG}
    paths:
      - node_modules/
  script:
    - npm run docker_smoke --single-run --progress false
  retry: 1
  #saving the HTML-Report
  artifacts:
    when: on_failure
    paths:
      - reporting/
    expire_in: 1 week
  allow_failure: true

# Regression suite ============================
regression_suite:
  stage: suiteRegression
  tags:
    - docker-in-docker
  cache:
    key: ${CI_COMMIT_REF_SLUG}
    paths:
      - node_modules/
  script:
    - npm run docker_regression --single-run --progress false
  retry: 1
  #saving the HTML-Report
  artifacts:
    when: on_failure
    paths:
      - reporting/
    expire_in: 1 week
  allow_failure: true

脚本需要遵守以下规则：

测试需要连续运行（因为如果同时执行它们可能会出现问题）。不过，执行顺序无关紧要。
如果其中一个测试失败，它会得到第二次机会，并会再执行一次。
如果其中一项测试在两次尝试中均失败并被标记为 'failed'，则无论如何仍将执行另一项测试。

有没有办法通过抽象来消除所有这些重复？如何实现？

Answer 1

您可以定义模板，然后使用它们扩展您的工作。

文档：https://docs.gitlab.com/ee/ci/yaml/#extends

示例：

.job-template:
  tags:
    - tag
  allow_failure: true

job1:
  extends:
    - .job-template
  script:
    - do something

job2:
  extends:
    - .job-template
  script:
    - do something

Answer 2

Gitlab 提供了几个 mechanisms to prevent duplications in your pipelines namely YAML anchors and the extends 关键字，而建议使用 extends 关键字以提高可读性。

应用于您的示例，您的管道可能如下所示：

image: node-karma-protractor

stages:
  - suiteSmoke
  - suiteRegression

.test:suite:
  stage: suiteSmoke
  tags:
    - docker-in-docker
  cache:
    key: ${CI_COMMIT_REF_SLUG}
    paths:
      - node_modules/
  before_script:
    - npm install
  retry: 1
  #saving the HTML-Report
  artifacts:
    when: on_failure
    paths:
      - reporting/
    expire_in: 1 week
  allow_failure: true

# Smoke suite =================================
smoke_suite:
  extends: .test:suite
  script:
    - npm run docker_smoke --single-run --progress false

# Regression suite ============================
regression_suite:
  extends: .test:suite
  script:
    - npm run docker_regression --single-run --progress false

如何消除使用几乎相同阶段的“.gitlab-ci.yml”脚本中的代码重复？

How to eliminate code repitition in a ".gitlab-ci.yml"-script that uses stages that are almost identical?

gitlab

continuous-integration

yaml

gitlab-ci

pipeline