0

Download job logs for a workflow run

by
Published Oct 25, 2023

Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.

Script github Verified

The script

Submitted by hugo697 Typescript (fetch-only)
Verified 398 days ago
1
type Github = {
2
  token: string;
3
};
4
/**
5
 * Download job logs for a workflow run
6
 * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look
7
for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can
8
use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must
9
have the `actions:read` permission to use this endpoint.
10
 */
11
export async function main(
12
  auth: Github,
13
  owner: string,
14
  repo: string,
15
  job_id: string
16
) {
17
  const url = new URL(
18
    `https://api.github.com/repos/${owner}/${repo}/actions/jobs/${job_id}/logs`
19
  );
20

21
  const response = await fetch(url, {
22
    method: "GET",
23
    headers: {
24
      Authorization: "Bearer " + auth.token,
25
    },
26
    body: undefined,
27
  });
28
  if (!response.ok) {
29
    const text = await response.text();
30
    throw new Error(`${response.status} ${text}`);
31
  }
32
  return await response.text();
33
}
34