如何在GitLab中实现依赖项目随库项目Jar更新自动同步

一、先把库项目的Jar发布到GitLab内置Maven仓库 #

别想着手动复制Jar到依赖项目，这会搞乱版本管理。正确的做法是把Jar发布到GitLab自带的Maven仓库，让依赖项目通过Maven直接拉取。

1. 修改库项目的pom.xml
   添加distributionManagement配置，指向你的GitLab Maven仓库：

   <distributionManagement>
       <repository>
           <id>gitlab-maven</id>
           <url>https://你的GitLab实例地址/api/v4/projects/你的库项目ID/packages/maven</url>
       </repository>
       <snapshotRepository>
           <id>gitlab-maven</id>
           <url>https://你的GitLab实例地址/api/v4/projects/你的库项目ID/packages/maven</url>
       </snapshotRepository>
   </distributionManagement>
   

   同时确保groupId、artifactId、version设置合理：开发阶段用快照版本（比如1.0.0-SNAPSHOT）方便自动更新；生产环境用正式版本。

2. 配置库项目的CI/CD流水线（.gitlab-ci.yml）
   添加发布步骤，打包完成后直接推送到GitLab仓库：

   stages:
     - build
     - publish
   
   build:
     stage: build
     image: maven:3.8.6-openjdk-17
     script:
       - mvn clean package
     artifacts:
       paths:
         - target/*.jar
   
   publish:
     stage: publish
     image: maven:3.8.6-openjdk-17
     script:
       - mvn deploy -s settings.xml
     only:
       - main # 仅主分支变更时触发发布
   

   在项目根目录创建settings.xml，用CI内置变量做认证，避免硬编码密码：

   <settings>
     <servers>
       <server>
         <id>gitlab-maven</id>
         <username>gitlab-ci-token</username>
         <password>${CI_JOB_TOKEN}</password>
       </server>
     </servers>
   </settings>
   

   这样库项目主分支一有变更，流水线就会自动打包并发布最新Jar到GitLab仓库。

二、让依赖项目自动拉取最新Jar #

分两种场景处理：

1. 开发阶段用快照版本 #

• 依赖项目的pom.xml中引入库的快照版本：

  <dependency>
      <groupId>你的库项目groupId</groupId>
      <artifactId>你的库项目artifactId</artifactId>
      <version>1.0.0-SNAPSHOT</version>
  </dependency>
  

• 依赖项目的流水线添加-U参数，强制更新快照依赖：

  build:
    stage: build
    image: maven:3.8.6-openjdk-17
    script:
      - mvn clean install -U # -U 强制拉取最新快照版本
  

  库项目一发布新的快照Jar，依赖项目下次运行流水线时就会自动拉取最新版本。

2. 生产环境用正式版本 #

需要自动更新依赖项目pom.xml中的版本号，再触发流水线：

第一步：库项目发布后自动修改依赖项目的pom

• 给依赖项目添加PROJECT_ACCESS_TOKEN的CI/CD变量，权限需包含api和write_repository。
• 修改库项目的.gitlab-ci.yml，添加更新依赖项目的步骤：

  update-dependent-project:
    stage: publish
    image: alpine/git:latest
    script:
      # 克隆依赖项目
      - git clone https://${PROJECT_ACCESS_TOKEN}@你的GitLab实例地址/你的依赖项目路径.git
      - cd 依赖项目目录
      # 获取库项目的最新正式版本号
      - LATEST_VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)
      # 替换pom.xml中的旧版本号
      - sed -i "s/<version>.*<\/version>/<version>${LATEST_VERSION}<\/version>/g" pom.xml
      # 提交并推送变更
      - git config user.name "GitLab CI/CD"
      - git config user.email "ci@yourcompany.com"
      - git add pom.xml
      - git commit -m "Update library dependency to ${LATEST_VERSION}"
      - git push origin main
    only:
      - main
    dependencies:
      - publish
  

第二步：依赖项目自动触发流水线

当依赖项目的pom.xml被更新并推送到主分支后，GitLab会自动触发流水线，此时构建会拉取最新的正式版Jar。

三、偷懒方案：用Maven版本插件自动更新 #

不想写脚本改pom的话，用versions-maven-plugin自动检测并更新最新版本：
在依赖项目的流水线中添加：

update-dependencies:
  stage: build
  image: maven:3.8.6-openjdk-17
  script:
    # 自动更新指定库的最新正式版本
    - mvn versions:use-latest-releases -Dincludes=你的库项目groupId:你的库项目artifactId
    - mvn clean install
    # 若需持久化版本变更，可添加git提交推送步骤

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