如何自定义publish-unit-test-result-action的Pull Request评论与测试摘要：完整配置指南

如何自定义publish-unit-test-result-action的Pull Request评论与测试摘要完整配置指南【免费下载链接】publish-unit-test-result-actionGitHub Action to publish unit test results on GitHub项目地址: https://gitcode.com/gh_mirrors/pu/publish-unit-test-result-actionpublish-unit-test-result-action是一个强大的GitHub Action工具专门用于在GitHub上发布单元测试结果。通过这个开源项目开发者可以轻松地将JUnit、NUnit、XUnit、TRX和JSON格式的测试结果自动发布到GitHub的检查运行、Pull Request评论和工作流摘要中。本文将详细介绍如何自定义Pull Request评论与测试摘要让你的测试报告更加清晰、实用。 publish-unit-test-result-action的核心功能这个GitHub Action能够自动分析测试结果文件并将结果发布到多个位置GitHub检查运行在提交页面显示测试状态Pull Request评论在PR讨论中展示详细的测试结果工作流摘要在工作流运行页面提供完整的测试报告默认情况下该Action会创建一个名为Test Results的检查运行并在相关的Pull Request中发表评论。但你可以通过多种配置选项来自定义这些行为。 自定义Pull Request评论标题通过comment_title参数你可以轻松修改Pull Request评论的标题。默认情况下评论标题与check_name相同但你可以单独设置- name: Publish Test Results uses: EnricoMi/publish-unit-test-result-actionv2 with: files: test-results/**/*.xml comment_title: 单元测试报告 check_name: Test Results这样配置后你的Pull Request评论将显示为 单元测试报告而检查运行仍保持Test Results的名称。️ 灵活控制评论显示模式comment_mode参数让你完全控制何时在Pull Request中显示评论。这个参数有多个选项可以根据不同的测试状态条件触发评论- name: Publish Test Results uses: EnricoMi/publish-unit-test-result-actionv2 with: files: test-results/**/*.xml comment_mode: changes in failures # 仅在失败数变化时评论可用的comment_mode选项模式触发条件适用场景always总是评论需要完整的测试历史记录changes与目标分支有变化时关注代码变更的影响changes in failures失败/错误数变化时重点关注失败的测试changes in errors错误数变化时只关注严重错误failures存在失败或错误时问题导向的讨论errors存在错误时只处理致命问题off不评论仅使用检查运行 配置检查运行名称check_name参数用于自定义GitHub检查运行的名称。这在同一工作流中有多个测试运行实例时特别有用- name: Publish Unit Test Results uses: EnricoMi/publish-unit-test-result-actionv2 with: files: test-results/**/*.xml check_name: 单元测试结果 comment_title: 单元测试报告 - name: Publish Integration Test Results uses: EnricoMi/publish-unit-test-result-actionv2 with: files: integration-results/**/*.xml check_name: 集成测试结果 comment_title: 集成测试报告 高级自定义选项1. 控制测试变化报告数量通过test_changes_limit参数你可以限制在Pull Request评论中显示的已移除或跳过的测试数量with: files: test-results/**/*.xml test_changes_limit: 5 # 最多显示5个测试变化设置为0可以完全禁用测试变化报告。2. 添加检查运行注解check_run_annotations参数允许你在检查运行中添加额外的注解信息with: files: test-results/**/*.xml check_run_annotations: all tests, skipped tests # 显示所有测试和跳过的测试3. 分支特定的注解配置check_run_annotations_branch参数让你只在特定分支上显示注解with: files: test-results/**/*.xml check_run_annotations: all tests check_run_annotations_branch: main, develop # 只在main和develop分支显示 工作流摘要配置job_summary参数控制是否将测试结果发布到工作流摘要页面with: files: test-results/**/*.xml job_summary: true # 默认启用 check_run: true # 默认启用检查运行你可以根据需要选择性地启用或禁用这些输出位置。例如如果你只想在Pull Request中看到评论可以with: files: test-results/**/*.xml job_summary: false # 禁用工作流摘要 check_run: true # 启用检查运行 comment_mode: always # 总是显示评论 比较早期提交的测试结果compare_to_earlier_commit参数允许你将当前测试结果与早期提交的结果进行比较with: files: test-results/**/*.xml compare_to_earlier_commit: true # 默认启用当启用此功能时Pull Request评论会显示测试结果的变化情况帮助你快速了解代码变更对测试的影响。️ 权限配置要点根据你的评论模式选择需要配置不同的GitHub权限permissions: checks: write # 除非使用 comment_mode: off否则需要此权限 pull-requests: write如果你完全禁用Pull Request评论可以省略pull-requests: write权限提高安全性。 实际配置示例以下是一个完整的配置示例展示了如何组合使用多个自定义选项name: Test and Publish Results on: [push, pull_request] jobs: test: runs-on: ubuntu-latest permissions: checks: write pull-requests: write steps: - name: Checkout code uses: actions/checkoutv4 - name: Run tests run: | # 运行测试并生成XML报告 ./run-tests.sh --output-format junit --output-file test-results/results.xml - name: Publish Test Results uses: EnricoMi/publish-unit-test-result-actionv2 if: always() with: files: test-results/**/*.xml check_name: 自动化测试套件 comment_title: 测试执行报告 comment_mode: changes in failures test_changes_limit: 8 job_summary: true check_run_annotations: all tests, skipped tests compare_to_earlier_commit: true 最佳实践建议为不同测试类型使用不同的check_name如果你的项目有单元测试、集成测试和端到端测试为每种类型使用不同的名称。根据团队需求选择comment_mode如果团队关注所有测试结果使用always如果只关心问题使用failures或errors。合理设置test_changes_limit对于大型项目建议设置为5-10避免评论过长。考虑安全性如果不需要Pull Request评论使用comment_mode: off并移除pull-requests: write权限。利用事件类型区分在工作流中使用事件类型来区分不同的测试运行check_name: Test Results (${{ github.event.workflow_run.event || github.event_name }}) 总结通过灵活配置publish-unit-test-result-action的Pull Request评论和测试摘要功能你可以创建高度定制化的测试报告体验。无论是简单的标题修改还是复杂的条件触发逻辑这个强大的工具都能满足你的需求。记住良好的测试报告不仅能帮助开发者快速定位问题还能提高团队的协作效率。花时间配置合适的评论和摘要设置将为你的项目带来显著的开发体验提升。开始自定义你的测试报告吧让每一次代码提交都有清晰、有用的测试反馈✨【免费下载链接】publish-unit-test-result-actionGitHub Action to publish unit test results on GitHub项目地址: https://gitcode.com/gh_mirrors/pu/publish-unit-test-result-action创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考