如何在GitLab CI作业中合并基础隐藏作业的rules规则实现复用?
问题场景
- 预设的隐藏基础作业配置:
.base_job: rules: - if: "$CI_COMMIT_TAG" when: never - if: '$CI_PIPELINE_SOURCE == "web"' - 期望的复用效果:
复用.base_job中定义的所有规则作为公共前置判断逻辑,同时允许每个自定义作业在公共规则之后追加自己的专属判断规则,示例结构:job_1: rules: - # 复用.base_job的全部规则 - if: "$CI_MERGE_REQUEST_IID" job_2: rules: - # 复用.base_job的全部规则 - if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH" - 现存卡点:
直接使用GitLab CI原生的extends字段引用基础作业无法实现预期效果。extends仅支持合并哈希结构,不支持合并数组,最终作业的rules数组会被自定义规则完全覆盖,无法和基础作业的规则拼接。当前手动复制粘贴基础规则的方式完全不符合DRY原则。
可行实现方案
方案1:使用GitLab原生!reference标签(推荐)
!reference是GitLab专门为CI配置提供的YAML扩展标签,可直接引用其他配置块中的具体值插入到当前位置,从根本上解决数组无法合并的问题。
实现示例:
.base_job: rules: - if: "$CI_COMMIT_TAG" when: never - if: '$CI_PIPELINE_SOURCE == "web"' job_1: rules: # 按索引逐行引用.base_job中的规则,保持原顺序 - !reference [.base_job, rules, 0] - !reference [.base_job, rules, 1] # 追加自定义规则 - if: "$CI_MERGE_REQUEST_IID" job_2: rules: - !reference [.base_job, rules, 0] - !reference [.base_job, rules, 1] # 追加自定义规则 - if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"
方案说明:
- 标签语法格式为
!reference [目标配置块, 目标字段, 数组索引],完全匹配基础配置的结构 - 规则匹配顺序可控,公共拦截规则放在最前面优先判断,符合GitLab规则从上到下的匹配逻辑
- 注意如果基础规则调整了条目顺序,需要同步修改引用的索引,避免匹配错误
方案2:使用YAML原生锚点+别名
如果GitLab版本较低不支持!reference标签,可以用YAML标准的锚点别名机制实现复用,所有支持YAML解析的环境均可使用。
实现示例:
# 给每条公共规则单独定义锚点,全局可复用 __common_rules__: rule_1: &common_rule_1 if: "$CI_COMMIT_TAG" when: never rule_2: &common_rule_2 if: '$CI_PIPELINE_SOURCE == "web"' # 基础作业也可以直接复用锚点 .base_job: rules: - *common_rule_1 - *common_rule_2 job_1: rules: - *common_rule_1 - *common_rule_2 - if: "$CI_MERGE_REQUEST_IID" job_2: rules: - *common_rule_1 - *common_rule_2 - if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"
方案说明:
- 所有公共规则的定义只需要维护一次,修改锚点内容时所有引用位置会自动同步生效,完全消除重复粘贴的问题
- 没有GitLab版本依赖,适配所有老旧版本的GitLab环境
- 缺点是如果公共规则条目较多,需要给每个条目单独定义锚点,配置步骤稍显繁琐
注意事项
无论使用哪种方案,都要保证公共的拦截类规则(比如tag场景禁止运行、web手动触发场景的判断)放在规则列表的最前面。GitLab的rules是从上到下顺序匹配,一旦命中某条规则就会停止后续判断,前置公共规则优先校验才能保证拦截逻辑不被自定义规则覆盖。
内容的提问来源于stack exchange,提问作者Ícaro
相关产品推荐
相关产品推荐

