0

List repositories with GitHub Actions cache usage for an organization

by
Published Oct 25, 2023

Lists repositories and their GitHub Actions cache usage for an organization. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration: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
 * List repositories with GitHub Actions cache usage for an organization
6
 * Lists repositories and their GitHub Actions cache usage for an organization.
7
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
8
You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint.
9
 */
10
export async function main(
11
  auth: Github,
12
  org: string,
13
  per_page: string | undefined,
14
  page: string | undefined
15
) {
16
  const url = new URL(
17
    `https://api.github.com/orgs/${org}/actions/cache/usage-by-repository`
18
  );
19
  for (const [k, v] of [
20
    ["per_page", per_page],
21
    ["page", page],
22
  ]) {
23
    if (v !== undefined && v !== "") {
24
      url.searchParams.append(k, v);
25
    }
26
  }
27
  const response = await fetch(url, {
28
    method: "GET",
29
    headers: {
30
      Authorization: "Bearer " + auth.token,
31
    },
32
    body: undefined,
33
  });
34
  if (!response.ok) {
35
    const text = await response.text();
36
    throw new Error(`${response.status} ${text}`);
37
  }
38
  return await response.json();
39
}
40