cfje/maven-resource

Maven Concourse Resource 镜像文档

镜像概述和主要用途

Maven Concourse Resource是专为Concourse CI/CD平台设计的资源类型，旨在无缝集成Maven构建流程。作为Concourse资源，它允许管道与Maven项目、仓库进行交互，自动化处理版本检测、依赖管理、构建执行和产物输出，减少手动配置Maven任务的复杂性，提升CI/CD管道中Maven相关流程的可维护性和一致性。

核心功能与特性

• Maven仓库交互：支持与本地或远程Maven仓库（如Nexus、Artifactory）通信，实现依赖拉取和产物推送
• 版本控制：自动检测Maven项目的版本变更（包括快照和发布版本），支持基于版本号的触发机制
• 依赖缓存：缓存Maven依赖以加速构建过程，减少重复下载依赖的时间消耗
• 构建产物处理：支持输出Maven构建产物（如JAR、WAR包），并可配置产物的元数据信息
• 灵活配置：支持自定义Maven命令、profiles、settings.xml配置，适配不同项目构建需求
• 认证集成：支持Maven仓库的用户名密码认证或令牌认证，保障私有仓库的访问安全

使用场景与适用范围

• Concourse CI/CD管道中的Maven项目构建：适用于需要在Concourse中自动化构建Java/Maven项目的场景
• 版本化发布管理：用于管理Maven项目的快照版本迭代和正式版本发布流程
• 多模块Maven项目构建：支持处理包含多个子模块的Maven项目，协调模块间依赖构建顺序
• 依赖敏感型项目：对依赖版本变更敏感的项目，通过版本检测自动触发构建验证
• 私有仓库集成：需访问私有Maven仓库的企业级项目，通过认证配置安全访问仓库资源

使用方法与配置说明

资源配置示例（Concourse Pipeline）

在Concourse pipeline.yml中定义Maven Concourse Resource资源：

yaml
resources:
- name: maven-project
  type: maven-concourse-resource
  source:
    group_id: com.example
    artifact_id: demo-project
    version_pattern: 1.0.*  # 匹配1.0.x版本
    repository_url: https://maven.example.com/repository/releases
    username: ((maven-repo-username))  # 从Concourse变量中获取认证信息
    password: ((maven-repo-password))
    maven_settings: |  # 自定义Maven settings配置
      <settings>
        <mirrors>
          <mirror>
            <id>central</id>
            <url>https://maven.example.com/repository/central</url>
            <mirrorOf>*</mirrorOf>
          </mirror>
        </mirrors>
      </settings>

资源参数说明

获取版本（get步骤）

在Concourse job中使用get步骤获取指定版本的Maven项目或依赖：

yaml
jobs:
- name: build-project
  plan:
  - get: maven-project
    trigger: true  # 当检测到新版本时自动触发job
    params:
      skip_download: false  # 是否跳过下载源码/依赖（默认false）
  - task: compile
    config:
      platform: linux
      image_resource:
        type: registry-image
        source: {repository: maven, tag: 3.8.5-openjdk-11}
      inputs:
      - name: maven-project  # 从资源获取的输入目录
      run:
        path: sh
        args:
        - -c
        - |
          cd maven-project
          mvn clean compile  # 执行Maven编译

输出产物（put步骤）

使用put步骤推送构建产物到Maven仓库：

yaml
jobs:
- name: release-project
  plan:
  - get: maven-project
  - task: package
    config:
      platform: linux
      image_resource: {repository: maven, tag: 3.8.5-openjdk-11}
      inputs: [{name: maven-project}]
      outputs: [{name: package}]  # 输出构建产物目录
      run:
        path: sh
        args:
        - -c
        - |
          cd maven-project
          mvn clean package -DskipTests
          cp target/*.jar ../package/
  - put: maven-project  # 推送产物到仓库
    params:
      file: package/*.jar  # 产物文件路径
      version: 1.0.0  # 指定发布版本号（若不指定则自动检测）
      classifier: app  # 可选，指定Maven构件分类器

版本自动检测配置

通过version_pattern实现动态版本检测，支持语义化版本匹配：

yaml
source:
  version_pattern: 1.0.*-SNAPSHOT  # 匹配1.0.x快照版本
  # 或使用正则表达式模式（需指定version_regex: true）
  version_pattern: ^1\.0\.\d+(-SNAPSHOT)?$
  version_regex: true