https://github.com/beacon-biosignals/docker-build
Build a Docker image while utilize caching from the image registry
https://github.com/beacon-biosignals/docker-build
ci-cd github-action
Last synced: about 1 month ago
JSON representation
Build a Docker image while utilize caching from the image registry
- Host: GitHub
- URL: https://github.com/beacon-biosignals/docker-build
- Owner: beacon-biosignals
- License: mit
- Created: 2025-01-09T14:49:12.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-03-25T14:01:34.000Z (about 1 month ago)
- Last Synced: 2025-03-25T15:22:59.605Z (about 1 month ago)
- Topics: ci-cd, github-action
- Language: Dockerfile
- Size: 50.8 KB
- Stars: 1
- Watchers: 14
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docker Build
Build a Docker image while utilizing [layer caching](https://docs.docker.com/build/cache/) backed from the image repository. Image tags will be automatically created based upon the relevant PR, branch name, and commit SHA.
When using this action we recommend utilizing a separate image repositories for development and production (e.g.`temporary/my-image` and `permanent/my-image`) to make it easier to separate temporary images from permanent images meant for end users. The `beacon-biosignals/docker-build` action is used to build temporary images under development. Once a temporary image is ready for production it can be promoted to be permanent by using `docker tag`/`docker push` or [`regctl image copy --digest-tags`](https://github.com/regclient/regclient/blob/main/docs/regctl.md#registry-commands) (if you want the digest to be identical across registries) to transfer the image.
Note that although [Docker does support using GitHub Actions cache](https://docs.docker.com/build/cache/backends/gha/) as a layer cache backend the GHA cache limit for a repository is 10 GB which is quite limiting for larger Docker images.
## Example
```yaml
---
on:
pull_request: {}
# Trigger this build workflow on "main". See `from-scratch`
push:
branches:
- main
jobs:
example:
# These permissions are needed to:
# - Get the workflow run: https://github.com/beacon-biosignals/docker-build#permissions
permissions: {}
runs-on: ubuntu-latest
steps:
- name: Build image
uses: beacon-biosignals/docker-build@v1
with:
image-repository: temporary/my-image
context: .
# Example of passing in Docker `--build-arg`
build-args: |
JULIA_VERSION=1.10
PYTHON_VERSION=3.10
# Example of passing in Docker `--secret`
build-secrets: |
github-token=${{ secrets.token || github.token }}
# Build images from scratch on "main". Ensures that caching doesn't result in using insecure system packages.
from-scratch: ${{ github.ref == 'refs/heads/main' }}
```
## Inputs
| Name | Description | Required | Example |
|:---------------------|:------------|:---------|:--------|
| `image-repository` | The Docker image repository to push the build image and cached layers. | Yes | `temporary/my-image` |
| `context` | The Docker build context directory. Defaults to `.`. | No | `./my-image` |
| `build-args` | List of [build-time variables](https://docs.docker.com/reference/cli/docker/buildx/build/#build-arg). | No |
HTTP_PROXY=http://10.20.30.2:1234
FTP_PROXY=http://40.50.60.5:4567
|
| `build-secrets` | List of [secrets](https://docs.docker.com/engine/reference/commandline/buildx_build/#secret) to expose to the build. | No | GIT_AUTH_TOKEN=mytoken
|
| `from-scratch` | Do not use cache when building the image. Defaults to `false`. | No | `false` |
## Outputs
| Name | Description | Example |
|:-------------------|:------------|:--------|
| `image` | Reference to the build image including the digest. | `temporary/my-image@sha256:37782d4e1c24d8f12047039a0d3512d1b6059e306a80d5b66a1d9ff60247a8cb` |
| `image-repository` | The Docker image repository where the image was pushed to. | `temporary/my-image` |
| `digest` | The built Docker image digest. | `sha256:37782d4e1c24d8f12047039a0d3512d1b6059e306a80d5b66a1d9ff60247a8cb` |
| `tags` | JSON list of tags associated with the built Docker image. | `branch-my-branch`, `sha-152cb14`, `pr-123` |
| `commit-sha` | The Git commit SHA used to build the image. | `152cb14643b50529b229930d6124e6bbef48668d` |
## Permissions
The follow [job permissions](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs) are required to run this action:
```yaml
permissions:
packages: write # Only required when using the GitHub Container registry: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry
```