API to read job summary

[mpelesh]

Job summary is a great new feature.
Is there a REST API to read job summary?

[Gisgar3]

As far as I know, there is no current way to fetch job summaries from the REST API. Try looking here for more information on getting data regarding workflow jobs! I hope this helps 😃

[ecout]

Since the Workflow run in my use case is an API triggered workflow_dispatch, I need to verify that the inputs of that event are correct via API call in order to query the dispatch.
IDEALLY, the workflow_dispatch event POST request should return a body containing data with the created workflow run, but it simply returns a 204, queues the request and only later on creates a workflow run for it.
We have to go through lot of request then to match the proper workflow run to the workflow_dispatch event. The API that you pointed out, lacks that data. The only thing I can think of now is annotations.

[ecout]

+1:

Please add this as it's another gap for integration(as discussed in the blog post below).

Documentation:
https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/
https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary

If there's a write at the action level, there should be a read at the API level.
Thanks!

[wonglkd]

Can't find this in the API, whether REST or GraphQL, but the raw Markdown can be accessed at /<owner>/<repo>/actions/runs/<run>/jobs/<job>/summary_raw, and someone made a GitHub action to generate this URL: https://github.com/pl-strflt/job-summary-url-action/tree/main

You do need to be logged in to access the summary, though.

[KyleKing]

Unfortunately, the /summary_raw wasn't working for me. It looks like GitHub has removed raw markdown and the linked GitHub Action returns a link to the Server Side Rendered webpage: /<owner>/<repo>/actions/runs/<run>/attempts/<attempt>#summary-<summary>

Example: https://github.com/libp2p/test-plans/actions/runs/5325838866/attempts/1#summary-14413504433 from: https://github.com/libp2p/test-plans/blob/3c7d726d4afaf3e41f1fc1bf27b3bd15baaa761c/.github/workflows/update-badge.yml#L43-L54 doesn't have content at: https://github.com/libp2p/test-plans/actions/runs/5325838866/attempts/1/summary_raw

[ilyamt-tandemg]

How about Render a Markdown document in raw mode?

[KyleKing]

@ilyamt-tandemg can you clarify how that would help?

[david-morris]

So I'm looking for an API to read the job summary, but that's not what I want to do.

All I want to do is to show the current commit's job summary or a placeholder on the PR page itself.

Shouldn't that be default? Like, you would see a "show summary" foldout on each of the completed checks?

[austenstone]

I made an action austenstone/job-summary-to-pdf

      - uses: austenstone/job-summary-to-pdf@main
        id: job-summary
        with:
          create-pdf: false
      - run: echo "${{ steps.job-summary.outputs.job-summary }}"

[theamk]

Info for others: this action works by looking at the parent dir of GITHUB_STEP_SUMMARY file and reading all the files there.
This means: (1) it only works within the current job, no fetching summaries from other jobs and (2) it only works while job is running.
It does, however upload the results as artifact so it can be downloaded later using artifact API.

It's a smart workaround, as long as you don't forget to add it to the end of each job definition you have.