Apache Yetus 技术文档

1. 安装指南

Apache Yetus 提供了两种安装方式：Docker 容器和直接在操作系统上安装。

Docker 容器安装

1. 运行以下命令启动包含所有项目依赖项的 Docker 容器，并创建一个工作的构建环境：

   ./start-build-env.sh
   

2. 在容器内构建项目：

   mvn clean install
   

直接在操作系统上安装

1. 确保安装了 Maven。

2. 运行以下命令构建项目：

   mvn clean install
   

3. 若要构建并签署内容，请运行：

   mvn clean install -Papache-release
   

4. 若在操作系统外部构建，并且需要通知系统使用 gpg2 而不是 gpg，请运行：

   mvn clean install -Papache-release -Pgpg2
   

5. 若要构建但跳过签署，请运行：

   mvn clean install -Papache-release -Dgpg.sign=skip
   

构建完成后，构件将位于 yetus-dist/target/artifacts 或准备进行 mvn deploy。

2. 项目使用说明

Apache Yetus 是一组库和工具的集合，用于支持软件项目的贡献和发布过程。以下是其主要组件：

• Website source: 持有项目文档，并通过项目网站展示。

• Precommit: 提供用于处理贡献的强大工具，包括从各种项目源应用补丁，并通过插件系统评估它们是否符合项目规范。查看 precommit 概述 以开始使用 precommit。

• Audience Annotations: 允许项目使用 Java 注解来区分 API 的公共和非公共部分。它还提供了 doclets 来生成按目标受众筛选的 javadocs。目前支持 Maven 3.2.0+。

• Shelldocs: 处理 Bash 函数上的注释，提供类似于 Javadoc 的注解。还包括类似于 Audience Annotations doclet 的内置受众范围功能。

• Release Doc Maker: 分析 Jira 和 Git 信息以生成 Markdown 格式的发行说明。

• yetus-maven-plugin: 构建一个 maven 插件，提供一些不常见的 maven 要求（如符号链接）的实用工具，以及 Apache Yetus 功能的一些 maven 化版本。

3. 项目API使用文档

Apache Yetus 的各个组件提供了丰富的 API，以下是一些使用示例：

• Precommit: 通过插件系统与项目的贡献过程集成。
• Audience Annotations: 使用 Java 注解来标注 API 的可见性。
• Shelldocs: 使用 Bash 函数注释生成文档。
• Release Doc Maker: 通过分析 Jira 和 Git 数据生成发行说明。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细说明，支持 Docker 容器和直接在操作系统上安装。请根据实际需求选择合适的安装方式。