ci: mirror ubuntu:22.04 to ghcr

Author: marcoieni

.github/workflows/ghcr.yml

@@ -0,0 +1,38 @@
+# Mirror DockerHub images used by the Rust project to ghcr.io.
+#
+# In some CI jobs, we pull images from ghcr.io instead of Docker Hub because
+# Docker Hub has a rate limit, while ghcr.io doesn't.
+# Those images are pushed to ghcr.io by this job.
+#
+# Note that authenticating to DockerHub or other registries isn't possible
+# for PR jobs, because forks can't access secrets.
+# That's why we use ghcr.io: it has no rate limit and doesn't require authentication.
+
+name: GHCR
+
+on:
+  schedule:
+    # Run daily at midnight UTC
+    - cron: '0 0 * * *'
+
+jobs:
+  mirror:
+    name: DockerHub mirror
+    runs-on: ubuntu-24.04
+    permissions:
+      # Needed to write to the ghcr.io registry
+      packages: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ github.token }}
+
+      - name: Mirror DockerHub
+        run: python3 src/ci/github-actions/ghcr.py
+        shell: bash

src/ci/github-actions/ghcr.py

@@ -0,0 +1,75 @@
+"""
+Use crane to mirror images from DockerHub to GHCR.
+Learn more about crane at
+https://github.com/google/go-containerregistry/blob/main/cmd/crane/README.md
+"""
+
+import os
+import requests
+import tarfile
+import shutil
+import subprocess
+from io import BytesIO
+from tempfile import TemporaryDirectory
+
+
+def crane_gh_release_url() -> str:
+    version = "v0.20.2"
+    os_name = "Linux"
+    arch = "x86_64"
+    base_url = "https://github.com/google/go-containerregistry/releases/download"
+    return f"{base_url}/{version}/go-containerregistry_{os_name}_{arch}.tar.gz"
+
+
+def download_crane():
+    """Download the crane executable from the GitHub releases in the current directory."""
+
+    try:
+        # Download the GitHub release tar.gz file
+        response = requests.get(crane_gh_release_url(), stream=True)
+        response.raise_for_status()
+
+        with TemporaryDirectory() as tmp_dir:
+            # Extract the tar.gz file to temp dir
+            with tarfile.open(fileobj=BytesIO(response.content), mode="r:gz") as tar:
+                tar.extractall(path=tmp_dir)
+
+            # The tar.gz file contains multiple files.
+            # Copy crane executable to current directory.
+            # We don't need the other files.
+            crane_path = os.path.join(tmp_dir, "crane")
+            shutil.copy2(crane_path, "./crane")
+
+        print("Successfully downloaded and extracted crane")
+
+    except requests.RequestException as e:
+        raise RuntimeError(f"Failed to download crane: {e}") from e
+    except (tarfile.TarError, OSError) as e:
+        raise RuntimeError(f"Failed to extract crane: {e}") from e
+
+
+def mirror_dockerhub():
+    # Images from DockerHub that we want to mirror
+    images = ["ubuntu:22.04"]
+    for img in images:
+        repo_owner = "rust-lang"
+        # Command to mirror images from DockerHub to GHCR
+        command = ["./crane", "copy", f"docker.io/{img}", f"ghcr.io/{repo_owner}/{img}"]
+        try:
+            subprocess.run(
+                command,
+                # if the process exits with a non-zero exit code,
+                # raise the CalledProcessError exception
+                check=True,
+                # open stdout and stderr in text mode
+                text=True,
+            )
+            print(f"Successfully mirrored {img}")
+        except subprocess.CalledProcessError as e:
+            raise RuntimeError(f"Failed to mirror {img}: {e}") from e
+    print("Successfully mirrored all images")
+
+
+if __name__ == "__main__":
+    download_crane()
+    mirror_dockerhub()