Enable Docker Layer Caching by adding a single line in GitHub Actions. This GitHub Action speeds up the building of docker images in your GitHub Actions workflow.
You can run docker build and docker-compose build in your GitHub Actions workflow using the cache with no special configuration, and it also supports multi-stage builds.
This GitHub Action uses the docker save / docker load command and the @actions/cache library.
name: CI
on: push
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
# Pull the latest image to build, and avoid caching pull-only images.
# (docker pull is faster than caching in most cases.)
- run: docker-compose pull
# In this step, this action saves a list of existing images,
# the cache is created without them in the post run.
# It also restores the cache if it exists.
- uses: satackey/action-docker-layer-caching@v0.0.3
- run: docker-compose up --build
# Finally, "Post Run satackey/action-docker-layer-caching@v0.0.3",
# which is the process of saving the cache, will be executed.name: CI
on: push
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
# In this step, this action saves a list of existing images,
# the cache is created without them in the post run.
# It also restores the cache if it exists.
- uses: satackey/action-docker-layer-caching@v0.0.3
- name: Build the Docker image
run: docker build . --file Dockerfile --tag my-image-name:$(date +%s)
# Finally, "Post Run satackey/action-docker-layer-caching@v0.0.3",
# which is the process of saving the cache, will be executed.See action.yml for details.
By default, the cache is separated by the workflow name. You can also set the cache key manually, like the official actions/cache action.
- uses: satackey/action-docker-layer-caching@v0.0.3
with:
key: foo-docker-cache-{hash}
restore-keys: |
foo-docker-cache-Note: You must include {hash} in the key input. ({hash} is replaced by the hash value of the docker image when the action is executed.)