如何将复杂Maven命令拆分为GitLab CI/CD的多阶段任务？

问题描述 #

我有一个Java项目，使用GitLab CI/CD流水线执行一系列Maven命令，希望每个Maven命令对应GitLab中的一个独立阶段/步骤。

我尝试的.gitlab-ci.yml配置如下：

script:
  - mvn clean install site -U org.pitest:pitest-maven:mutationCoverage jacoco:prepare-agent jacoco:report dependency:tree pmd:cpd pmd:pmd javadoc:javadoc checkstyle:checkstyle spotbugs:spotbugs

但实际执行时，所有操作都集中在单个build阶段完成，仅能看到一个build步骤（日志显示确实执行了pitest、jacoco等操作），而我预期呈现build→pitest→jacoco→…的多阶段可视化流程。请问如何实现将每个Maven命令设为独立阶段？

解决方案 #

要实现每个Maven命令对应GitLab CI/CD的独立阶段，需完成两项核心配置：声明流水线阶段顺序和为每个阶段创建独立Job，同时注意Job间的构建产物传递（每个Job默认在独立环境运行）。

1. 定义流水线阶段顺序 #

首先在.gitlab-ci.yml顶部通过stages关键字声明阶段的执行顺序，示例如下：

stages:
  - build
  - pitest
  - jacoco
  - dependency-check
  - pmd
  - javadoc
  - checkstyle
  - spotbugs

阶段列表的顺序直接决定流水线的执行流程，只有前一阶段的所有Job执行成功，才会触发下一阶段的Job。

2. 为每个阶段创建独立Job #

每个Job需要指定所属的stage，并在script中执行单一Maven命令；同时通过artifacts和dependencies传递构建产物（如target目录），确保后续Job能基于前序构建结果执行。

完整示例配置：

stages:
  - build
  - pitest
  - jacoco
  - dependency-check
  - pmd
  - javadoc
  - checkstyle
  - spotbugs

# 构建阶段：执行基础编译打包，生成核心产物
build:
  stage: build
  script:
    - mvn clean install -U
  artifacts:
    paths:
      - target/
    expire_in: 1h  # 产物有效期可按需调整

# 变异测试阶段
pitest:
  stage: pitest
  script:
    - mvn org.pitest:pitest-maven:mutationCoverage
  dependencies:
    - build  # 依赖build阶段的产物

# JaCoCo代码覆盖率报告生成
jacoco:
  stage: jacoco
  script:
    - mvn jacoco:prepare-agent jacoco:report
  dependencies:
    - build

# 依赖树分析
dependency-check:
  stage: dependency-check
  script:
    - mvn dependency:tree
  dependencies:
    - build

# PMD代码质量检查（含重复代码检测）
pmd:
  stage: pmd
  script:
    - mvn pmd:cpd pmd:pmd
  dependencies:
    - build

# 生成Javadoc文档
javadoc:
  stage: javadoc
  script:
    - mvn javadoc:javadoc
  dependencies:
    - build
  artifacts:
    paths:
      - target/site/apidocs/  # 可选：持久化Javadoc产物
    expire_in: 7d

# Checkstyle代码风格检查
checkstyle:
  stage: checkstyle
  script:
    - mvn checkstyle:checkstyle
  dependencies:
    - build

# SpotBugs静态代码分析
spotbugs:
  stage: spotbugs
  script:
    - mvn spotbugs:spotbugs
  dependencies:
    - build

# 可选：添加Maven依赖缓存，加速Job执行
cache:
  paths:
    - ~/.m2/repository/

关键说明 #

• 产物传递：artifacts用于保存当前Job的输出，dependencies用于指定当前Job需要依赖的前置Job产物，确保后续Maven命令能获取到编译后的类文件等资源。
• 阶段调整：可根据项目实际需求修改stages列表的顺序，调整各环节的执行先后。

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