.NET测试报告生成器使用教程

.NET测试报告生成器使用教程

dotnet-tests-report GitHub Action to run .NET Core tests and generate report attached to Workflow Run 项目地址: https://gitcode.com/gh_mirrors/do/dotnet-tests-report

1. 项目目录结构及介绍

开源项目 dotnet-tests-report 的目录结构如下：

• .github/
  • 包含GitHub工作流配置文件。
• docs/
  • 存放项目文档。
• tests/
  • 存放测试项目。
• trx-report/
  • 生成测试报告的文件夹。
• .gitignore
  • 指定Git应该忽略的文件和文件夹。
• LICENSE
  • 项目使用的许可证文件。
• NOTES.md
  • 项目笔记或重要信息。
• README.md
  • 项目说明文件。
• Step-GitVersionTag.md
  • 步骤文档，可能包含版本标记说明。
• Step-GitVersionTag.ps1
  • PowerShell脚本，可能用于版本标记。
• action.ps1
  • PowerShell脚本，是GitHub Action的核心部分。
• action.yml
  • GitHub Action的定义文件。
• action_helpers.ps1
  • PowerShell辅助脚本。
• build.ps1
  • 构建脚本。
• invoke-pwsh.js
  • JavaScript脚本，用于调用PowerShell。
• package-lock.json
  • 包锁定文件，用于锁定项目的依赖。
• package.json
  • Node.js项目文件，定义项目依赖。

2. 项目的启动文件介绍

项目的启动主要通过GitHub Action的 action.yml 文件来配置。以下是 action.yml 的基本结构：

name: 'dotnet-tests-report'
description: 'GitHub Action to run .NET tests and generate report'
inputs:
  project_path:
    description: 'Path to the test project'
    required: true
  report_name:
    description: 'Name of the report'
    required: true
  report_title:
    description: 'Title of the report'
    required: true
  github_token:
    description: 'GitHub token'
    required: true

该文件定义了GitHub Action的输入参数，用户在使用时需要根据实际情况提供这些参数。

3. 项目的配置文件介绍

项目的配置主要通过GitHub Action的工作流配置文件来实现。以下是一个工作流配置示例：

jobs:
  test:
    runs-on: 'ubuntu-latest'
    steps:
      - name: 'use this action, test solution dir'
        uses: 'zyborg/dotnet-tests-report@v1'
        with:
          project_path: 'tests/My.Project.Tests'
          report_name: 'my_project_tests'
          report_title: 'My Project Tests'
          github_token: '${{ secrets.GITHUB_TOKEN }}'

在这个配置文件中，定义了一个工作 test，它运行在 ubuntu-latest 虚拟环境上。步骤中使用了 zyborg/dotnet-tests-report@v1 Action，并且配置了测试项目路径、报告名称、报告标题以及GitHub token。

用户需要根据实际项目路径和参数调整上述配置，以便正确执行测试并生成报告。

dotnet-tests-report GitHub Action to run .NET Core tests and generate report attached to Workflow Run 项目地址: https://gitcode.com/gh_mirrors/do/dotnet-tests-report