开源项目教程：action-junit-report

1. 项目介绍

action-junit-report 是一个GitHub Action，用于在拉取请求（Pull Request）中展示JUnit测试结果。该工具可以将JUnit XML格式的测试报告转换为GitHub的Pull Request Check，并显示测试结果的摘要和注释。

2. 项目快速启动

以下是一个简单的示例，展示如何将 action-junit-report 集成到您的GitHub工作流程中。

首先，在您的GitHub仓库中创建一个新的工作流程文件（例如 .github/workflows/build.yml），然后添加以下内容：

name: Build and Run Tests

on: [pull_request]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout Code
      uses: actions/checkout@v4

    - name: Build and Run Tests
      run: |
        # 执行您的测试并生成测试结果
        # 此处为示例命令，您需要替换为实际的测试命令
        npm test

    - name: Publish Test Report
      uses: mikepenz/action-junit-report@v5
      if: success() || failure()
      with:
        report_paths: '**/build/test-results/test/TEST-*.xml'

确保您的测试命令生成的JUnit报告路径与 report_paths 的配置相匹配。

3. 应用案例和最佳实践

案例一：自定义检查名称和摘要

您可以通过添加额外的配置来自定义检查名称和摘要内容，以下是一个示例：

    - name: Publish Test Report
      uses: mikepenz/action-junit-report@v5
      if: success() || failure()
      with:
        report_paths: '**/build/test-results/test/TEST-*.xml'
        check_name: '自定义检查名称'
        summary: '这是一个自定义的摘要信息'

案例二：处理测试失败和解析错误

如果测试失败或JUnit报告文件无法解析，您可以选择让工作流程失败：

    - name: Publish Test Report
      uses: mikepenz/action-junit-report@v5
      if: success() || failure()
      with:
        report_paths: '**/build/test-results/test/TEST-*.xml'
        fail_on_failure: true
        fail_on_parse_error: true

4. 典型生态项目

action-junit-report 通常与以下类型的开源项目配合使用：

• 使用JUnit进行单元测试的Java项目
• 使用GitHub Actions进行持续集成（CI）的任何项目
• 需要在Pull Request中直接展示测试结果的项目

这个GitHub Action可以帮助开发者确保代码质量，通过直观的方式展示测试结果，从而提高代码的可维护性和可靠性。