Apache Yetus test-patch GitHub Action 使用教程

1. 项目的目录结构及介绍

Apache Yetus test-patch GitHub Action 项目的目录结构如下：

.
├── LICENSE
├── NOTICE
├── README.md
├── action.yml
├── asf.yaml
├── release.sh
└── src
    └── ...

• LICENSE: 项目的许可证文件，采用 Apache-2.0 许可证。
• NOTICE: 项目所需的通知文件。
• README.md: 项目的说明文档，包含项目的基本介绍和使用方法。
• action.yml: GitHub Action 的配置文件，定义了 Action 的输入、输出和运行步骤。
• asf.yaml: Apache 软件基金会相关的配置文件。
• release.sh: 用于发布项目的脚本文件。
• src: 源代码目录，包含项目的主要代码。

2. 项目的启动文件介绍

项目的启动文件是 action.yml，该文件定义了 GitHub Action 的运行流程。以下是 action.yml 的主要内容：

name: Apache Yetus test-patch
on: [push, pull_request]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
        with:
          path: src
          fetch-depth: 0
      - name: Apache Yetus test-patch
        uses: apache/yetus-test-patch-action@main
        with:
          basedir: /src
          patchdir: /out
          buildtool: nobuild
          githubtoken: $[[ secrets.GITHUB_TOKEN ]]
      - name: Artifact output
        if: $[[ always() ]]
        uses: actions/upload-artifact@v2
        with:
          name: apacheyetuspatchdir
          path: $[[ github.workspace ]]/out

• name: 定义 Action 的名称。
• on: 定义触发 Action 的事件，这里是 push 和 pull_request。
• jobs: 定义工作流程中的任务。
  • build: 定义一个名为 build 的任务。
    • runs-on: 指定运行任务的虚拟环境，这里是 ubuntu-latest。
    • steps: 定义任务的具体步骤。
      • Checkout: 使用 actions/checkout@v2 进行代码检出。
      • Apache Yetus test-patch: 使用 apache/yetus-test-patch-action@main 进行测试补丁。
      • Artifact output: 上传测试结果作为工件。

3. 项目的配置文件介绍

项目的配置文件主要是 action.yml，该文件定义了 GitHub Action 的输入、输出和运行步骤。以下是 action.yml 的配置项介绍：

• basedir: 指定代码库的根目录。
• patchdir: 指定测试补丁的输出目录。
• buildtool: 指定是否使用构建工具，这里设置为 nobuild，表示不使用。
• githubtoken: 指定 GitHub 的访问令牌，用于访问 GitHub API。

通过这些配置项，可以灵活地配置和运行 Apache Yetus test-patch GitHub Action。

---

以上是 Apache Yetus test-patch GitHub Action 的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用该项目。