apache/yetus

Apache Yetus Docker镜像

镜像概述和主要用途

Apache Yetus是一个集成库和工具的集合，旨在支持软件项目的贡献流程和发布过程。其Docker镜像提供了预配置的运行环境，包含项目所需的操作系统、插件依赖项以及预安装的Apache Yetus二进制文件，简化了项目构建、测试和持续集成的实施过程。

核心功能和特性

Apache Yetus核心组件支持

Docker镜像支持Apache Yetus的主要组件运行，包括：

• Website source：项目文档源，通过官方网站（[***]
• Precommit：处理贡献的工具集，支持应用多源补丁并通过插件系统评估项目规范符合性
• Audience Annotations：Java注解工具，用于划分API的公共/非公共部分，提供按受众过滤的Javadoc生成功能（支持Maven 3.2.0+）
• Shelldocs：Bash函数注释处理器，支持类Javadoc注解及受众范围功能
• Release Doc Maker：分析Jira和Git信息生成Markdown格式发布说明
• yetus-maven-plugin：Maven插件，提供特殊需求工具（如符号链接）及Yetus功能的Maven化实现

镜像特性

• 全依赖环境：预安装所有项目依赖，无需手动配置构建环境
• 双镜像版本：提供基础依赖镜像（yetus-base）和完整运行环境镜像（yetus）
• 版本稳定性：提供标记发布版本和主分支镜像，推荐使用标记版本避免兼容性问题
• 即开即用：完整镜像中的二进制文件位于/usr/bin，直接加入系统PATH

使用场景和适用范围

• CI/CD系统：作为持续集成环境，自动化执行代码检查、构建验证和贡献评估
• 开发环境：为团队提供一致的本地开发和测试环境，消除"在我机器上能运行"问题
• 项目发布：简化Apache Yetus项目本身的构建、打包和签名流程
• 交互式操作：通过完整镜像进行命令行交互，快速验证工具功能和配置

使用方法和配置说明

镜像获取

可从ghcr.io拉取官方镜像：

bash
# 拉取基础依赖镜像
docker pull ghcr.io/apache/yetus-base

# 拉取包含二进制文件的完整镜像
docker pull ghcr.io/apache/yetus

基础依赖镜像（yetus-base）

包含Apache Yetus支持的所有工具和依赖，适用于外部运行Yetus二进制文件的场景，可加速测试容器构建。

使用示例：

bash
# 启动交互式容器，挂载本地项目目录
docker run -it --rm -v $(pwd):/workspace ghcr.io/apache/yetus-base /bin/bash

# 在容器内准备项目依赖
cd /workspace
./prepare-dependencies.sh

完整运行镜像（yetus）

基于yetus-base构建，额外包含预安装的Apache Yetus二进制文件，适用于CI环境或直接交互式使用。

使用示例：

bash
# 查看Yetus版本
docker run --rm ghcr.io/apache/yetus yetus --version

# 执行预提交检查
docker run --rm -v $(pwd):/project ghcr.io/apache/yetus precommit \
  --source /project \
  --branch main \
  --plugins all

# 生成发布说明
docker run --rm -v $(pwd):/project ghcr.io/apache/yetus releasedocmaker \
  --jira-project YETUS \
  --version 0.14.0 \
  --git-repo /project

本地构建环境

如需构建Apache Yetus项目，可使用项目脚本启动包含完整依赖的构建容器：

bash
# 克隆项目仓库
git clone https://github.com/apache/yetus.git
cd yetus

# 启动构建环境容器
./start-build-env.sh

# 在容器内执行构建
mvn clean install

# 构建带签名的发布包
mvn clean install -Papache-release

# 构建项目网站
mvn site site:stage

构建产物将位于yetus-dist/target/artifacts目录下。