qcastel/maven-release

Maven Release Docker镜像

概述

该Docker镜像预设了git、maven和gpg环境，并集成了由bot触发发布的脚本，旨在简化Maven项目的自动化发布流程。通过提供预置工具链和自动化脚本，支持GPG签名、版本管理、安全认证等关键发布环节，适用于CI/CD环境中由bot执行的可靠发布任务。

核心功能和特性

• GPG签名：支持使用GPG对发布 artifacts 进行签名，确保完整性与真实性
• SSH git仓库认证：通过SSH私钥实现git仓库的安全访问与认证
• Bot用户提交：使用指定的bot用户信息执行git提交操作，明确发布主体
• 版本递增：支持主版本（Major）、次版本（Minor）或补丁版本（Patch）的自动递增
• 发布失败回滚：若mvn prepare步骤执行失败，自动回滚发布过程，保障代码库一致性
• 自定义发布分支名：允许指定自定义发布分支，控制发布触发条件
• 日志时间戳：日志中包含时间戳，便于追踪和排查Maven性能问题

使用场景和适用范围

适用于需要自动化Maven项目发布流程的场景，特别适合：

• 需对发布 artifacts 进行GPG签名的安全合规项目
• 使用SSH协议管理git仓库的版本控制流程
• 要求严格区分主/次/补丁版本的版本管理策略
• 需要发布失败自动恢复机制的高可靠性发布流程
• CI/CD流水线中由bot触发的自动化发布任务

使用方法和配置说明

核心脚本

镜像内置核心发布脚本：release.sh，用于执行完整的发布流程自动化。

环境变量配置

脚本运行依赖以下环境变量，需根据项目需求配置：

GPG相关配置

SSH相关配置

Maven相关配置

Docker Registry相关配置

其他配置

部署示例

Docker Run命令示例

bash
docker run -e GPG_ENABLED=true \
  -e GPG_KEY_ID=ABC123456 \
  -e GPG_KEY="$(base64 /local/path/to/gpg_private.key)" \
  -e GPG_PASSPHRASE=your_gpg_passphrase \
  -e SSH_PRIVATE_KEY="$(base64 /local/path/to/ssh_private.key)" \
  -e MAVEN_REPO_SERVER_ID=central \
  -e MAVEN_REPO_SERVER_USERNAME=maven_user \
  -e MAVEN_REPO_SERVER_PASSWORD=maven_pass \
  -e VERSION_MINOR=true \
  -e RELEASE_BRANCH_NAME=release \
  [镜像名称] /release.sh

Docker Compose配置示例（片段）

yaml
version: '3'
services:
  maven-release:
    image: [镜像名称]
    environment:
      GPG_ENABLED: "true"
      GPG_KEY_ID: "ABC***"
      GPG_KEY: "${GPG_PRIVATE_KEY_BASE64}"
      GPG_PASSPHRASE: "${GPG_PASSPHRASE}"
      SSH_PRIVATE_KEY: "${SSH_PRIVATE_KEY_BASE64}"
      MAVEN_REPO_SERVER_ID: "central"
      MAVEN_REPO_SERVER_USERNAME: "${MAVEN_USERNAME}"
      MAVEN_REPO_SERVER_PASSWORD: "${MAVEN_PASSWORD}"
      VERSION_MINOR: "true"
      RELEASE_BRANCH_NAME: "release"
      GIT_RELEASE_BOT_NAME: "release-bot"
      GIT_RELEASE_BOT_*** "***"
    command: /release.sh