GitLab CI如何为带复杂规则的deploy作业设置smoke-test运行依赖
解决方案
你使用的GitLab 14.4.2版本完全支持needs: optional特性,这是当前场景下的最优解,无需重复配置规则,也不需要改动现有deploy作业的配置。
方案1:使用needs: optional(推荐)
GitLab 14.3及以上版本对needs关键字做了优化,新增optional参数,作用是:当被依赖的作业因规则判断未被加入流水线时,不会导致整个流水线创建失败,当前作业会自动跳过。
你只需要给smoke-test作业做如下配置即可:
smoke-test: # 其余原有配置(镜像、脚本等)保持不变 needs: - job: deploy optional: true when: on_success
该配置的逻辑完全符合你的预期:
- 若deploy作业未被加入流水线:smoke-test自动跳过,无任何报错
- 若deploy作业执行成功:smoke-test自动触发运行
- 若deploy作业执行失败:smoke-test自动跳过
方案2:抽离公共规则用extends复用
如果你后续有更多作业需要复用deploy的规则,可以把规则单独抽离为独立的YAML片段,跨文件引用,完全不需要依赖YAML锚点:
- 新建公共规则文件(例如
.gitlab/ci/rules/deploy.yaml),内容如下:
.deploy-job-rules: rules: - if: $CI_KUBERNETES_DEPLOYMENT_ENABLED != "true" when: never - if: $STAGING_CHART_DIRECTORY == "" when: never - if: $STAGING_NAMESPACE == "" when: never - if: $CI_REVIEW_DEPLOYMENT_ENABLED != "true" && $CI_MERGE_REQUEST_ID when: never - if: $CI_MERGE_REQUEST_ID && $CI_COMMIT_REF_PROTECTED == "true" when: never - when: on_success
- 在deploy和smoke-test所在的YAML文件中引入该公共文件,并用
extends复用规则:
# 引入公共规则文件 include: - local: '.gitlab/ci/rules/deploy.yaml' deploy: extends: .deploy-job-rules # 其余配置保持不变 smoke-test: extends: .deploy-job-rules needs: [deploy] # 其余配置保持不变
后续规则变更只需要修改公共规则文件即可,所有复用的作业都会同步生效,维护成本极低。
方案3:dotenv变量传递(备选)
如果因为特殊限制不能使用前两个方案,可以用dotenv制品传递变量实现:
- 在deploy作业的脚本末尾添加变量输出,同时配置dotenv制品:
deploy: # 其余原有配置不变 script: # 原有部署脚本不变 - echo "DEPLOY_JOB_SUCCESS=true" >> deploy.env artifacts: reports: dotenv: deploy.env
- smoke-test作业配置如下:
smoke-test: # 其余原有配置不变 needs: - job: deploy optional: true rules: - if: $DEPLOY_JOB_SUCCESS == "true" when: on_success
内容的提问来源于stack exchange,提问作者Eduard Tomek
相关产品推荐
相关产品推荐

