Skip to content
This repository has been archived by the owner on Sep 9, 2022. It is now read-only.

Latest commit

 

History

History
121 lines (80 loc) · 4.37 KB

readme.md

File metadata and controls

121 lines (80 loc) · 4.37 KB
Raw

Docker build-with-cache action

This action builds your docker image and cache the stages (supports multi-stage builds) to improve building times in subsequent builds.

By default it pushes the image with all the stages to a registry (needs username and password), but you can disable this feature setting push_image_and_stages to false.

Built-in support for Docker Hub, AWS ECR, GitHub's registry, and Google Cloud.

IMPORTANT! To use built-in support to AWS ECR, you need to use v5 (see example below)

Inputs

Required

image_name: Image name with namespace (eg: whoan/node).

Optional

username: Docker registry's user (needed to push image to repository, or to pull from private repository).

password: Docker registry's password (needed to push image to repository, or to pull from private repository).

registry: Docker registry (default: Docker Hub's registry).

image_tag: Tag(s) of the image to build. Allows multiple comma-separated tags (eg: one,another) (default: latest).

context: Docker context (default: ./).

dockerfile: Dockerfile filename path (default: "$context"/Dockerfile)

push_image_and_stages: Set to false to avoid pushing to registry. Useful when you use on: pull_request. (default: true).

push_git_tag: In addition to image_tag, you can also push the git tag in your branch tip (default: false)

pull_image_and_stages: Set to false to avoid pulling from registry or to build from scratch (default: true).

build_extra_args: Provide extra arguments to docker build. eg: "--compress=true --build-arg=hello=world"

Outputs

None

How it works

The action does the following every time it is triggered:

  • (Optional) Pull previously pushed stages (if any) from the specified registry (default: https://hub.docker.com)
  • Build the image using cache (ie: using any the pulled stages)
  • Tag the image (multiple tags are allowed)
  • (Optional) Push the image with the tag(s) specified in image_tag
  • (Optional) Push each stage of the built image to the registry with the name <image_name>-stages:<1,2,3,...>
  • (Optional) Push the git tag (if available) as <image_name>:<git_tag>

Example usage

Minimal example:

- uses: whoan/docker-build-with-cache-action@v5
  with:
    image_name: whoan/node

Using GitHub's registry:

GitHub automatically creates a GITHUB_TOKEN secret to use in your workflow.

- uses: whoan/docker-build-with-cache-action@v5
  with:
    username: your_usernames
    password: "${{ secrets.GITHUB_TOKEN }}"
    image_name: whoan/docker-images/node
    image_tag: alpine-slim
    push_git_tag: true
    registry: docker.pkg.github.com
    context: node-alpine-slim
    build_extra_args: "--compress=true --build-arg=hello=world"

Another example for Google Cloud Platform and more custom settings:

More info here on how to get GCloud JSON key.

- uses: whoan/docker-build-with-cache-action@v5
  with:
    username: _json_key
    password: "${{ secrets.GCLOUD_JSON_KEY }}"
    registry: gcr.io
    image_name: your_id/your_image
    image_tag: latest,and,more,tags
    context: sub_folder_in_your_repo
    dockerfile: custom.dockerfile
    push_image_and_stages: false  # useful when you are setting a workflow to run on PRs

Finally, (since v5) an example to use AWS ECR:

You don't even need to create the repositories in advance, as this action takes care of that for you!

- uses: whoan/docker-build-with-cache-action@v5
  with:
    username: "${{ secrets.AWS_ACCESS_KEY_ID }}"
    password: "${{ secrets.AWS_SECRET_ACCESS_KEY }}"
    image_name: node
    registry: 123456789.dkr.ecr.us-west-1.amazonaws.com

Cache is not working?

Be aware of the conditions that can invalidate your cache:

  • Be specific with the base images. If you start from an image with latest tag, it may download different versions when the action is triggered, and it will invalidate the cache.

License

MIT