Remove dangling images from GHCR on schedule (pi-hole#941)

* Remove dangling images from GHCR on schedule

Signed-off-by: Fernando Fernández <[email protected]>

* Commit .sh file as executable, so preparation is not needed at runtime

Signed-off-by: Fernando Fernández <[email protected]>

* Update .github/workflows/maintenance.yml

Signed-off-by: Adam Warner <[email protected]>

* Update .github/workflows/maintenance.yml

Signed-off-by: Fernando Fernández <[email protected]>

Co-authored-by: Adam Warner <[email protected]>

Author: 2 people

.github/workflows/maintenance.yml

@@ -0,0 +1,33 @@
+name: Maintenance 🧰
+
+on:
+  schedule:
+    - cron: "0 0 * * *"
+  workflow_dispatch:
+
+jobs:
+  dangling_images_removal:
+    runs-on: ubuntu-latest
+    name: Cleanup dangling images from GHCR 🧹📦
+    # Errors will probably be caused by excesses in API quota, so we can safely continue.
+    # Remaining images will be removed in the next scheduled run.
+    continue-on-error: true
+    # Pay attention that the org name is not necessary here, as gh will automatically take the one from the logged in user.
+    # REMEMBER TO KEEP THIS UP TO DATE WITH A LIST OF THE PUBLISHED PACKAGES.
+    strategy:
+      fail-fast: false
+      matrix:
+        container:
+          - 'pihole'
+          - 'ftl-build'
+          - 'docker-pi-hole-base'
+
+    steps:
+      - name: Clone repository 🔽
+        uses: actions/[email protected]
+
+      - name: Run deletion script 🗑
+        run: ./delete_ghcr_dangling_images.sh ${{ matrix.container }}
+        working-directory: ./.github/workflows/maintenance
+        env:
+          GITHUB_TOKEN: ${{ secrets.DELETE_PACKAGE_TOKEN }}

.github/workflows/maintenance/delete_ghcr_dangling_images.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+set -e
+
+# Simple script to remove dangling images from GHCR
+# You need to be logged to 'gh' first.
+
+# package_name syntax. i.e: jellyfin-vue
+container="$1"
+temp_file="ghcr_prune.ids"
+rm -rf $temp_file
+
+echo "Fetching dangling images from GHCR..."
+gh api /user/packages/container/${container}/versions --paginate > $temp_file
+
+ids_to_delete=$(cat "$temp_file" | jq -r '.[] | select(.metadata.container.tags==[]) | .id')
+
+if [ "${ids_to_delete}" = "" ]
+then
+	echo "There are no dangling images to remove for this package"
+	exit 0
+fi
+
+echo -e "\nDeleting dangling images..."
+while read -r line; do
+	id="$line"
+	## Workaround for https://github.com/cli/cli/issues/4286 and https://github.com/cli/cli/issues/3937
+	echo -n | gh api --method DELETE /user/packages/container/${container}/versions/${id} --input -
+	echo Dangling image with ID $id deleted successfully
+done <<< $ids_to_delete
+
+rm -rf $temp_file
+echo -e "\nAll the dangling images have been removed successfully"
+exit 0