登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  文章 >  软件教程

GitHub Actions job summary 怎样展示 Go 测试结果

来源:17golang原创

时间:2026-11-17 23:38:40 406浏览 收藏

GitHub Actions 的 job summary 适合放“这次 Go 测试到底怎样”的短结论,而不是把整份日志搬到页面上。做法是让测试步骤保留真实退出码,再把通过/失败状态、有限的错误片段和后续入口追加到 GITHUB_STEP_SUMMARY。这样打开一次 workflow run,先看摘要判断影响,再决定是否展开日志或下载完整报告。

官方地址:https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands

本文用一个已有 Go 工作流来说明配置路径。示例中的界面图是原创操作示意图,不是 GitHub 页面截图;YAML 和显示结果是可复制的写法与推导示例,未在本文生成过程中运行。

先分清摘要、日志和完整测试报告

job summary 的入口是当前步骤对应的 GITHUB_STEP_SUMMARY 环境文件。向它追加 GitHub Flavored Markdown 后,步骤结束时内容会汇总到 workflow run 的运行摘要页。它适合展示结论、关键数字、失败用例名称和排查入口;详细堆栈、完整 go test 输出或机器消费的 JSON 则应该继续留在日志或 artifact 中。

内容推荐位置读者用途
是否通过、失败原因、少量片段job summary打开运行页后快速判断
完整命令输出、堆栈步骤日志逐行排查
JSON、覆盖率、JUnit 等文件artifact下载、归档或交给工具处理

官方文档还说明,摘要按步骤隔离;单个步骤的摘要有大小上限,job 还存在可显示的摘要数量上限。因此“摘要”是导航和结论层,不是日志仓库。

把 Go 测试步骤接到摘要文件

在仓库的 .github/workflows/ 中打开已有工作流,在安装 Go 和依赖之后加入测试步骤。结果验收型写法通常拆成三段:测试步骤记录退出结果、摘要步骤无论成功失败都执行、最后的门禁步骤把失败状态交还给 job。

工作流编辑页中 Go 测试步骤、摘要文件和失败保留步骤的原创界面说明图
图1:工作流配置的原创操作示意图,关注 Go 测试步骤、GITHUB_STEP_SUMMARY 和失败保留步骤的位置,不是实际页面截图。
name: Go tests

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4 # 拉取当前提交,保证测试输入一致。

      - name: Setup Go
        uses: actions/setup-go@v5 # 使用工作流声明的 Go 版本。
        with:
          go-version: '1.23'

      - name: Run Go tests
        id: go_test
        continue-on-error: true # 先让摘要步骤有机会展示失败摘要。
        shell: bash
        run: |
          set +e # 测试失败时先记录退出码,不让 shell 立即结束。
          go test ./... 2>&1 | tee go-test.log
          test_status=${PIPESTATUS[0]} # 取 go test 的退出码,不取 tee 的退出码。
          echo "status=$test_status" >> "$GITHUB_OUTPUT" # 给后续门禁步骤使用。
          exit "$test_status"

      - name: Write Go test summary
        if: always() # 测试成功或失败都要写入摘要。
        shell: bash
        run: |
          {
            echo "## Go 测试摘要"
            if [ "${{ steps.go_test.outcome }}" = "success" ]; then
              echo "- ✅ 测试步骤已通过"
            else
              echo "- ❌ 测试步骤失败,请展开日志"
            fi
            echo "- 测试命令:`go test ./...`"
            echo ""
            echo "### 关键输出片段"
            echo '```text'
            sed -n '1,120p' go-test.log # 只展示有限片段,完整内容仍在步骤日志。
            echo '```'
          } >> "$GITHUB_STEP_SUMMARY" # 追加 Markdown 到当前步骤摘要。

      - name: Fail job when tests failed
        if: steps.go_test.outcome == 'failure'
        run: exit 1 # 摘要写完后恢复测试门禁,避免失败被吞掉。

这里最容易写错的是管道退出码:go test ./... | tee 的最后一个命令是 tee,所以直接读取 $? 可能得到 tee 的结果。Bash 的 PIPESTATUS[0] 才是这次 Go 测试的退出码。continue-on-error 只负责给摘要留出执行机会,最后一个门禁步骤仍会让 job 保持失败。

用 Markdown 写出读者真正需要的结论

GITHUB_STEP_SUMMARY 支持 Markdown。单行内容可以用 echo "..." >> "$GITHUB_STEP_SUMMARY",多行内容用一个代码块包住,并且全部使用追加重定向。若需要重写当前步骤的摘要,用 > 覆盖;不要在不同步骤之间假设它们共享同一个摘要文件。

摘要建议保持三层:第一层是状态,第二层是少量能帮助定位的输出,第三层是行动提示。比如失败时写出“测试步骤失败,请展开日志”,比复制几千行堆栈更容易让值班同学开始排查。

  • 状态:通过、失败或被跳过。
  • 范围:执行的命令和测试包范围。
  • 线索:前 120 行失败片段、失败测试名称或短错误信息。
  • 入口:步骤日志、artifact 或报告地址。

如果需要在多个步骤写内容,每个步骤的摘要会在运行结束时组合到 job summary;不要把“前一步写了标题,后一步只写正文”当成跨步骤的共享变量设计。把每个步骤写入的内容设计成可独立阅读的 Markdown,阅读体验更稳定。

在运行摘要页核对 Go 测试结论

推送工作流后打开对应的 workflow run,先看 job 是否成功,再看运行摘要中是否出现“Go 测试摘要”。成功场景应该同时看到通过状态和测试命令;失败场景应该看到失败状态,但 job 仍然是失败,而不是因为 continue-on-error 变成绿色。

运行摘要页中 Go 测试摘要、job 状态、日志和报告入口的原创界面说明图
图2:最终结果的原创操作示意图,按 Job 状态、Go 测试摘要、有限片段和完整日志入口核对,不是线上运行截图。
看到的状态说明下一步
摘要存在,job 成功测试通过且摘要步骤执行完成看是否需要保留 artifact
摘要存在,job 失败测试或门禁失败,但摘要成功写出先看片段,再展开完整日志
没有摘要摘要步骤未进入、文件变量为空或步骤本身提前退出检查 if: always()、Shell 错误和路径
摘要很长或上传异常把日志当成摘要写入,超过单步承载边界缩短片段并上传完整日志文件

这一步核对的是工作流状态和页面承载关系,不是把页面上的一段绿色文字当成测试证据。真正的测试结论来自 Go 测试步骤的退出码;摘要只是把结果以更快的方式呈现出来。

大日志、矩阵和完整报告怎么安排

当测试输出可能很大时,可以只把失败前后的少量片段写进摘要,把完整日志作为 artifact。GitHub 的 Go 工作流文档也展示了将 go test -json 输出保存后上传的思路。摘要负责“现在发生了什么”,artifact 负责“以后如何复盘”。

矩阵 job 要特别注意命名:每个矩阵组合都可能生成自己的 job summary。摘要中加上 Go 版本、操作系统或测试分组,读者才能知道卡片对应哪个组合。不要把不同组合的结果覆盖到同一个本地文件后再上传,否则排查时会丢失上下文。

      - name: Upload complete Go test log
        if: always() # 无论测试结果怎样,都保留完整日志文件。
        uses: actions/upload-artifact@v4
        with:
          name: go-test-log-${{ matrix.go-version }} # 矩阵维度放进名称,避免相互覆盖。
          path: go-test.log
          if-no-files-found: warn # 没有日志时给出提示,不把摘要逻辑伪装成报告上传。

如果团队需要 JUnit、覆盖率或趋势图,应把对应文件交给专门的报告流程;不要为了让摘要页“看起来完整”而复制全部机器输出。摘要越短,越适合在失败列表中快速扫描。

发布前可按这份清单确认

  1. 摘要写入的是当前步骤的 GITHUB_STEP_SUMMARY,不是普通工作区文件。
  2. 测试步骤的真实退出码已保存,continue-on-error 没有吞掉最终失败。
  3. 摘要步骤使用 if: always(),成功和失败都能留下结论。
  4. 摘要只包含状态和有限片段,完整日志或报告另行保留。
  5. 矩阵摘要带有版本、系统或测试分组标识。
  6. 失败场景同时核对页面摘要、job 状态和步骤日志。

两个容易混淆的问题

摘要写成功,为什么 job 还是红色? 因为摘要写入和测试退出码是两件事。本文让摘要步骤继续执行,但最后的门禁步骤会依据 Go 测试结果返回非零退出码,红色状态才不会被掩盖。

能不能把完整 go test 输出都写进摘要? 不建议。摘要有单步骤大小限制,页面也不适合承载长日志。把摘要控制在结论、少量片段和排查入口,完整输出上传为 artifact 或留在步骤日志里。

把 job summary 当成“运行结果首页”来设计就够了:Go 测试决定成败,摘要负责让人第一眼看懂,日志和 artifact 负责提供细节。三者职责分开,工作流失败时仍能留下有用的信息,成功时也不会把页面变成一堵日志墙。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>