如何获取GitHub Actions工作流程摘要？

Question

我需要获取特定RUN_ID的工作流程摘要（即我使用$GITHUB_STEP_SUMMARY发布的信息）。 我查阅了https://docs.github.com/en/rest, https://github.com/actions/github-script, GH CLI手册 - 但我仍然不明白如何获取这些数据。

- Vitaly Karasik DevOps

Answer 1

这些工作摘要的路径有点复杂...

首先调用作业运行的 REST API：

https://api.github.com/repos/{owner}/{repo}/actions/runs/{runid}/jobs

这将返回一个json负载：

{
  "total_count": 1,
  "jobs": [
    {
      "id": 13143160145,
      "run_id": 4850518271,
      "workflow_name": "test",
      "head_branch": "main",
      "run_url": "https://api.github.com/repos/{owner}/{repo}/actions/runs/4850518271",
      "run_attempt": 1,
      "node_id": "CR_kwDOJV3v7c8AAAADD2S1UQ",
      "head_sha": "db07f0a8a0eb2104583a4165c86d4da5603c8944",
      "url": "https://api.github.com/repos/{owner}/{repo}/actions/jobs/13143160145",
      "html_url": "https://github.com/{owner}/{repo}/actions/runs/4850518271/jobs/8643488313",
      "status": "completed",
      "conclusion": "success",
      "created_at": "2023-05-01T10:40:11Z",
      "started_at": "2023-05-01T10:40:18Z",
      "completed_at": "2023-05-01T10:40:20Z",
      "name": "build",
      "steps": [
...

现在获取 html_url 并将最后一个 ID 去掉：https://github.com/{owner}/{repo}/actions/runs/4850518271/jobs/**8643488313**

然后使用该 ID 获取 summary_raw：

https://github.com/{owner}/{repo}/actions/runs/4850518271/jobs/8643488313/summary_raw

这应该返回作业摘要的原始降价。

我不确定那个ID表示什么，因为我在文档中找不到参考。

- jessehouwing

---

我一直在查找相关内容，那个ID看起来确实有些神秘。使用GitHub CLI无法获取它。我找到的最接近的是 gh run view --log | grep GITHUB_STEP_SUMMARY，但需要进行一些清理。本来应该更简单的，因为文档说它已经上传到某个地方了。一个直接的链接会更容易使用。 - Azeem

我怀疑有一个直接的链接，但你需要正确的URL才能找到它。我还没有找到这个ID代表什么。 - jessehouwing

@jessehouwing - 非常感谢！我怀疑有一个直接的链接，但你需要正确的URL才能找到它，我还没有找到这个ID代表什么。在我的情况下，工作流有几个作业，因此最直接的解决方案（但缺失的）应该为工作流提供摘要，而不是每个作业。 - Vitaly Karasik DevOps

不确定这是否已经过时，但对于我来说，html_url等同于：https://github.com/owner/repo/actions/runs/6122437571/job/16618189294。它是job，而不是jobs，在尝试获取摘要时无法正常工作。 - undefined