GitHub Actions 提供 GITHUB_STEP_SUMMARY 文件,可把 Markdown 摘要显示在运行页面。写明执行的测试、使用的配置和完整报告的位置。

验证失败场景


分别测试成功和受控失败的运行。如果失败后仍需生成报告,设置相应的步骤条件,并确认原始失败仍然可见。不要在摘要中写入凭据或敏感测试数据。

让审核者拿到可核对的结果


有效的摘要应在要求读者下载文件前,先回答三个问题:哪一个提交和配置运行了,哪些通过或失败,详细证据在哪里。把它们放在结果旁边,方便区分不同重试。

Bash 步骤可以用 printf 输出固定标题和换行,再追加到带引号的 GITHUB_STEP_SUMMARY 路径。加入测试工具实际产生的统计,以及已上传报告的链接。统计必须来自同一次运行。把详细日志保存在产物中,让摘要引导读者找到失败案例。

例如运行了 120 项测试,其中两项失败。摘要应指出失败套件、统计及报告位置。如果测试命令中止后摘要步骤未执行,检查报告步骤的条件,让失败路径也能产生报告。同时保留测试命令的失败结果,使作业仍然显示失败。

用一个已知成功和一个故意失败的案例验证。分别打开运行摘要,点击报告,并将统计与测试日志核对。报告还必须属于正确的提交和配置。

补充官方参考

https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#adding-a-job-summary