GitLab CI中如何先构建依赖项目以解决主项目Maven依赖问题

你遇到的错误是因为主项目依赖的com.xyz.common:restful-client和com.xyz.common:utilities是内部私有项目，未发布到Maven中央仓库，CI环境无法自动拉取这些依赖。以下是两种可行的解决方法：

方案一：CI中先拉取并构建依赖项目 #

直接在主项目的CI流水线中，先克隆依赖项目并执行mvn install，将依赖包安装到CI环境的本地Maven仓库，之后主项目就能正常构建。

修改后的GitLab CI配置示例：

image: maven:3-openjdk-11

stages:
  - prepare-deps
  - build
  - test
  - package

# 新增前置步骤：构建并安装依赖项目
prepare_deps_job:
  stage: prepare-deps
  script:
    # 克隆restful-client项目，替换为你的GitLab项目地址，用CI_JOB_TOKEN做权限认证
    - git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com/xyz/common/restful-client.git
    - cd restful-client
    - mvn install -DskipTests # 跳过测试加快构建，仅生成安装依赖包
    - cd ..
    # 克隆utilities项目
    - git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com/xyz/common/utilities.git
    - cd utilities
    - mvn install -DskipTests

build_job:
  stage: build
  script:
     - echo "Maven compile started"
     - "mvn -f the-core/pom.xml compile"

test_job:
  stage: test
  script:
      - echo "Maven test started"
      - "mvn test"

package_job:
   stage: package
   script:
      - echo "Maven packaging started"
      - "mvn package"

注意事项 #

• 确保CI_JOB_TOKEN拥有克隆依赖项目的权限，私有项目可提前配置部署密钥或项目访问权限。
• -DskipTests参数可根据需求选择，若依赖项目需要确保测试通过可移除。

方案二：将依赖项目发布到GitLab包仓库 #

长期维护推荐此方案：给依赖项目配置CI，构建后将产物发布到GitLab Maven仓库，主项目直接从该仓库拉取依赖，无需每次重复构建依赖项目。

步骤1：配置依赖项目的CI发布流程 #

在依赖项目的.gitlab-ci.yml中添加发布任务：

image: maven:3-openjdk-11

stages:
  - deploy

deploy_job:
  stage: deploy
  script:
    - mvn deploy -s settings.xml
  only:
    - tags # 仅在打标签时发布正式版本，可根据需求调整触发条件

同时在依赖项目根目录创建settings.xml，配置GitLab仓库认证：

<settings>
  <servers>
    <server>
      <id>gitlab-maven</id>
      <configuration>
        <httpHeaders>
          <property>
            <name>Job-Token</name>
            <value>${CI_JOB_TOKEN}</value>
          </property>
        </httpHeaders>
      </configuration>
    </server>
  </servers>
  <profiles>
    <profile>
      <id>gitlab-maven</id>
      <repositories>
        <repository>
          <id>gitlab-maven</id>
          <url>${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/maven</url>
        </repository>
      </repositories>
      <distributionManagement>
        <repository>
          <id>gitlab-maven</id>
          <url>${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/maven</url>
        </repository>
        <snapshotRepository>
          <id>gitlab-maven</id>
          <url>${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/maven</url>
        </snapshotRepository>
      </distributionManagement>
    </profile>
  </profiles>
  <activeProfiles>
    <activeProfile>gitlab-maven</activeProfile>
  </activeProfiles>
</settings>

步骤2：主项目配置依赖仓库 #

在主项目的pom.xml中添加GitLab仓库地址，替换[依赖项目PROJECT_ID]为实际项目ID：

<repositories>
  <repository>
    <id>gitlab-maven</id>
    <url>https://gitlab.com/api/v4/projects/[依赖项目PROJECT_ID]/packages/maven</url>
  </repository>
</repositories>

同时主项目的CI也需要配置settings.xml，用CI_JOB_TOKEN认证访问GitLab仓库，确保能拉取到私有依赖。

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