Monitor your GitHub Actions storage usage with a script

1
# Ensure the GitHub CLI is authenticated
2
if ! gh auth status > /dev/null 2>&1; then
3
  echo "Please authenticate with the GitHub CLI using 'gh auth login'."
4
  exit 1
5
fi
6

7
# Check if the owner is provided
8
if [ -z "$1" ]; then
9
  echo "Usage: $0 <owner>"
10
  echo "Example: $0 owner"
11
  exit 1
12
fi
13

14
OWNER=$1
15

16
# Check if the owner type is provided
17
echo "Is the owner an organization or a user? (org/user)"
18
read -r OWNER_TYPE
19

20
if [[ "$OWNER_TYPE" != "org" && "$OWNER_TYPE" != "user" ]]; then
21
  echo "Invalid input. Please specify 'org' or 'user'."
22
  exit 1
23
fi
24

25
echo "Fetching repositories for owner: $OWNER"
26

27
PAGE=1
28
TOTAL_ARTIFACT_SIZE=0
29
TOTAL_CACHE_SIZE=0
30

31
while true; do
32
  # Fetch repositories for the given owner based on type (paginated, including private and internal)
33
  if [ "$OWNER_TYPE" == "org" ]; then
34
    REPOS_RESPONSE=$(gh api -H "Accept: application/vnd.github+json" \
35
      "/orgs/$OWNER/repos?type=all&per_page=100&page=$PAGE")
36
  else
37
    REPOS_RESPONSE=$(gh api -H "Accept: application/vnd.github+json" \
38
      "/users/$OWNER/repos?type=all&per_page=100&page=$PAGE")
39
  fi
40

41
  REPOS=$(echo "$REPOS_RESPONSE" | jq -r '.[].full_name')
42
  if [ -z "$REPOS" ]; then
43
    break
44
  fi
45

46
  echo "Repositories on page $PAGE:"
47
  echo "$REPOS"
48

49
  for REPO in $REPOS; do
50
    echo "Processing repository: $REPO"
51
    REPO_PAGE=1
52
    REPO_ARTIFACT_SIZE=0
53

54
    while true; do
55
      # Fetch artifacts for the repository (paginated)
56
      RESPONSE=$(gh api -H "Accept: application/vnd.github+json" \
57
        "/repos/$REPO/actions/artifacts?per_page=100&page=$REPO_PAGE")
58

59
      # Extract artifact sizes and sum them up
60
      SIZES=$(echo "$RESPONSE" | jq '.artifacts[].size_in_bytes' 2>/dev/null)
61
      if [ -z "$SIZES" ]; then
62
        break
63
      fi
64

65
      for SIZE in $SIZES; do
66
        REPO_ARTIFACT_SIZE=$((REPO_ARTIFACT_SIZE + SIZE))
67
      done
68

69
      # Check if there are more pages
70
      HAS_NEXT_PAGE=$(echo "$RESPONSE" | jq '.artifacts | length == 100')
71
      if [ "$HAS_NEXT_PAGE" != "true" ]; then
72
        break
73
      fi
74

75
      REPO_PAGE=$((REPO_PAGE + 1))
76
    done
77

78
    # Fetch cache usage for the repository
79
    CACHE_RESPONSE=$(gh api -H "Accept: application/vnd.github+json" \
80
      "/repos/$REPO/actions/cache/usage")
81

82
    REPO_CACHE_SIZE=$(echo "$CACHE_RESPONSE" | jq '.active_caches_size_in_bytes // 0')
83

84
    # Add to total sizes
85
    TOTAL_ARTIFACT_SIZE=$((TOTAL_ARTIFACT_SIZE + REPO_ARTIFACT_SIZE))
86
    TOTAL_CACHE_SIZE=$((TOTAL_CACHE_SIZE + REPO_CACHE_SIZE))
87

88
    # Convert sizes to GB
89
    REPO_ARTIFACT_SIZE_GB=$(echo "scale=2; $REPO_ARTIFACT_SIZE / 1024 / 1024 / 1024" | bc)
90
    REPO_CACHE_SIZE_GB=$(echo "scale=2; $REPO_CACHE_SIZE / 1024 / 1024 / 1024" | bc)
91

92
    echo "Total artifact size for $REPO: $REPO_ARTIFACT_SIZE_GB GB"
93
    echo "Total cache size for $REPO: $REPO_CACHE_SIZE_GB GB"
94
  done
95

96
  # Check if there are more pages of repositories
97
  HAS_NEXT_PAGE=$(echo "$REPOS_RESPONSE" | jq 'length == 100')
98
  if [ "$HAS_NEXT_PAGE" != "true" ]; then
99
    break
100
  fi
101

102
  PAGE=$((PAGE + 1))
103
done
104

105
# Log total sizes across all repositories
106
TOTAL_ARTIFACT_SIZE_GB=$(echo "scale=2; $TOTAL_ARTIFACT_SIZE / 1024 / 1024 / 1024" | bc)
107
TOTAL_CACHE_SIZE_GB=$(echo "scale=2; $TOTAL_CACHE_SIZE / 1024 / 1024 / 1024" | bc)
108

109
echo "========================================"
110
echo "Total artifact size across all repositories: $TOTAL_ARTIFACT_SIZE_GB GB"
111
echo "Total cache size across all repositories: $TOTAL_CACHE_SIZE_GB GB"

1
> ./check-artifacts-usage.sh my-organization
2
Is the owner an organization or a user? (org/user)
3
> org
4
Fetching repositories for owner: my-organization
5
my-organization/repo1
6
my-organization/repo2
7

8
Processing repository: my-organization/repo1
9
Total artifact size for my-organization/repo1: 0 GB
10
Total cache size for my-organization/repo1: 0 GB
11
...
12
========================================
13
Total artifact size across all repositories: 24.42 GB
14
Total cache size across all repositories: 4.09 GB