Add support for caching with Github Actions cache

.github/workflows/test.yml

@@ -2,6 +2,31 @@ name: Unit Tests
 on: [push, pull_request]
 
 jobs:
+  testactions_cache:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        githubToken: [true, false]
+        githubActionsCache: [true, false]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build and run container
+        id: build
+        uses: ./
+        with:
+          githubActionsCache: '${{ matrix.githubActionsCache }}'
+          githubToken: "${{ matrix.githubToken && github.token || '' }}"
+          arch: aarch64
+          distro: bullseye
+          run: |
+            echo "Ran successfully"
+
   testactions_job:
     runs-on: ubuntu-latest
     name: Test

.gitignore

@@ -1 +1,2 @@
-.vscode/
+.vscode/
+.idea/

README.md

@@ -14,7 +14,8 @@ This action requires three input parameters:
 
 The action also accepts some optional input parameters:
 
-* `githubToken`: Your GitHub token, used for caching Docker images in your project's public package registry. Usually this would just be `${{ github.token }}`. This speeds up subsequent builds and is highly recommended.
+* `githubActionsCache`: Set to `true` to cache with GitHub Actions cache instead of GitHub Package Registry. This speeds up subsequent builds and is highly recommended.
+* `githubToken`: Your GitHub token, used for caching Docker images in your project's public package registry rather than using GitHub Actions cache. Usually this would just be `${{ github.token }}`.
 * `env`: Environment variables to propagate to the container. YAML, but must begin with a `|` character. These variables will be available in both run and setup.
 * `shell`: The shell to run commands with in the container. Default: `/bin/sh` on Alpine, `/bin/bash` for other distros.
 * `dockerRunArgs`: Additional arguments to pass to `docker run`, such as volume mappings. See [`docker run` documentation](https://docs.docker.com/engine/reference/commandline/run).
@@ -36,6 +37,11 @@ jobs:
     name: Build on ubuntu-22.04 armv7
     steps:
       - uses: actions/checkout@v4
+
+      # Only required if you are using the GitHub Actions cache. 
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
       - uses: uraimo/run-on-arch-action@v2
         name: Run commands
         id: runcmd
@@ -44,8 +50,8 @@ jobs:
           distro: ubuntu22.04
 
           # Not required, but speeds up builds by storing container images in
-          # a GitHub package registry.
-          githubToken: ${{ github.token }}
+          # the GitHub Actions cache between runs.
+          githubActionsCache: 'true'
 
           # Set an output parameter `uname` for use in subsequent steps
           run: |

action.yml

@@ -17,6 +17,11 @@ inputs:
     description: 'Your GitHub token, used for caching Docker images in your project''s public package registry. Usually this would just be $\{{ github.token }}. This speeds up builds and is highly recommended.'
     required: false
     default: ''
+  githubActionsCache:
+    description: 'Your GitHub Actions cache, used for caching Docker images in your project''s public package registry. This speeds up builds and is highly recommended.'
+    required: false
+    type: boolean
+    default: false
   env:
     description: 'Environment variables to propagate to the container. YAML, but must begin with a | character. These variables will be available in both run and setup.'
     required: false