项目教程：action-junit-report

1. 项目目录结构及介绍

action-junit-report 是一个用于处理 JUnit XML 测试报告并将其展示为 GitHub PR 检查的开源项目。以下是项目的目录结构及其简单介绍：

• /.devcontainer/：包含开发环境配置。
• /.github/：包含 GitHub 工作流文件和相关的配置。
• /__tests__/：包含项目的单元测试代码。
• /dist/：存放编译后的文件。
• /src/：项目的源代码，包括 JavaScript 和 TypeScript 文件。
• /test_results/：存放测试结果文件。
• /：根目录还包含一些配置文件和项目说明文件。

2. 项目的启动文件介绍

项目的启动主要是通过 GitHub Actions 工作流来触发的。以下是一些关键文件：

• / workflows/build.yml：这是触发构建和测试的主要工作流文件。它定义了工作流触发条件、运行环境、步骤等。
• /action.yml：这是定义 GitHub Action 的元数据文件，包括 Action 的名称、描述等。

当有 Pull Request 时，工作流将被触发，执行以下步骤：

1. Checkout Code：检出代码。
2. Build and Run Tests：构建并运行测试，生成测试结果。
3. Publish Test Report：使用 mikepenz/action-junit-report@v5 发布测试报告。

3. 项目的配置文件介绍

项目的配置文件主要包括 GitHub Actions 工作流配置和其他一些项目配置。

• workflows/build.yml 中的配置示例：

name: build

on:
  pull_request:

jobs:
  build:
    name: Build and Run Tests
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v4
      - name: Build and Run Tests
        run: # execute your tests generating test results
      - name: Publish Test Report
        uses: mikepenz/action-junit-report@v5
        if: success() || failure()
        with:
          report_paths: '**/build/test-results/test/TEST-*.xml'

在这个配置中，report_paths 是用来指定 JUnit 测试报告文件的位置，if 条件用来确定何时发布测试报告，with 用来配置 Action 的参数。

• 其他配置文件如 .prettierrc.json、jest.config.js、tsconfig.json 等用来配置项目的代码风格、测试框架和 TypeScript 编译选项等。

以上是关于 action-junit-report 项目的目录结构、启动文件和配置文件的简单介绍。使用这个项目可以帮助开发者在 GitHub 上更好地集成和展示测试结果。