多GitLab项目下复用Shell脚本函数的CI模板优化咨询

问题原因 #

原模板使用default.before_script加载函数脚本，但当引入模板的项目自定义了before_script时，会直接覆盖默认配置，导致函数脚本未被加载，无法正常调用函数。

优化方案 #

方案1：使用!reference定义可复用脚本片段（推荐，GitLab 13.9+支持） #

将加载函数的命令封装为独立可复用片段，项目可灵活在before_script或script中引用，完全避免被覆盖问题。

修改后的function.yml：

# 定义可复用的函数加载脚本片段
.scripts:load_functions:
  - source scripts/functions.sh

# 可选：提供基础Job模板，供需要使用函数的Job直接继承
.base_job_with_functions:
  before_script:
    - !reference [.scripts:load_functions]

项目中使用方式

• 方式A：继承基础Job
  自动加载函数，无需额外配置：

  include:
    - local: template/function.yml
  
  stages:
    - testproject
  
  testproject:
    stage: testproject
    extends: .base_job_with_functions
    script:
      - echoFunction "This is a pattern derived from the other yml file"
  

• 方式B：自定义before_script时引用片段
  可同时保留项目自定义的前置操作：

  include:
    - local: template/function.yml
  
  stages:
    - testproject
  
  testproject:
    stage: testproject
    before_script:
      - !reference [.scripts:load_functions]
      - echo "执行项目自定义前置操作"
    script:
      - echoFunction "This is a pattern derived from the other yml file"
  

• 方式C：直接在script中引用
  适合不需要before_script的场景：

  include:
    - local: template/function.yml
  
  stages:
    - testproject
  
  testproject:
    stage: testproject
    script:
      - !reference [.scripts:load_functions]
      - echoFunction "This is a pattern derived from the other yml file"
  

方案2：锚点+引用（兼容旧版GitLab） #

通过YAML锚点定义加载命令，项目可直接引用，无需依赖高版本GitLab特性。

修改后的function.yml：

# 定义锚点，存储加载函数的命令
.load_functions: &load_functions
  source scripts/functions.sh

# 可选：基础Job模板
.base_job_with_functions:
  before_script:
    - *load_functions

项目中使用方式

include:
  - local: template/function.yml

stages:
  - testproject

testproject:
  stage: testproject
  before_script:
    - *load_functions
    - echo "项目自定义前置操作"
  script:
    - echoFunction "This is a pattern derived from the other yml file"

方案3：使用prepend强制加载（GitLab 15.4+支持） #

通过prepend关键字将模板的before_script添加到项目配置的最前面，确保函数脚本优先加载，且不会被项目自定义配置覆盖。

修改后的function.yml：

default:
  before_script:
    - prepend:
        - source scripts/functions.sh

项目中使用方式

直接引入模板即可，项目自定义的before_script会在模板命令之后执行：

include:
  - local: template/function.yml

stages:
  - testproject

testproject:
  stage: testproject
  before_script:
    - echo "项目自定义前置操作"
  script:
    - echoFunction "This is a pattern derived from the other yml file"

注意事项 #

• 确保functions.sh文件路径正确：若模板和脚本在同一项目，使用local引入时，路径是相对于引入项目的根目录；若模板在独立项目，需使用remote引入并调整路径。
• 根据团队使用的GitLab版本选择合适方案，优先推荐方案1，兼顾灵活性和可读性。

内容的提问来源于stack exchange，提问作者viratpuar