Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Docker Workflow #212

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update Docker Workflow #212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2d21679
Update Docker Workflow
yordanovsstoyan Sep 17, 2024
2345693
Update Docker Workflow
yordanovsstoyan Sep 17, 2024
5e1b257
Update Docker Workflow
yordanovsstoyan Sep 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
132 changes: 122 additions & 10 deletions .github/workflows/docker-build-and-publish.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,16 @@ on:
required: false
type: boolean
default: false
runs-on:
description: "Runner config as JSON object string. Each key is one of the input `platforms` and each value is the list of runner tags on which the Docker image for that platform should be natively built on. Defaults to a mapping from expected possible `platforms` to GitHub runners native to that architecture."
required: false
default: "{ 'linux/amd64': ['ubuntu-22.04'], 'linux/arm64': ['linux-arm-latest'] }"
type: string
platforms:
description: "Architectures for the created image (comma separated)"
required: false
default: "['linux/amd64']"
type: string

secrets:
docker-user:
Expand All @@ -68,9 +78,13 @@ concurrency:
cancel-in-progress: ${{ github.ref_name != github.event.repository.default_branch }}

jobs:
build-and-publish:
name: Build and Publish
runs-on: ubuntu-22.04
build-and-push:
strategy:
matrix:
platform: ${{ fromJson(inputs.platforms) }}

name: Build for ${{ matrix.platform }}
runs-on: ${{ fromJson(inputs.runs-on)[matrix.platform] }}
steps:
- name: Check out repository
uses: bakdata/ci-templates/actions/[email protected]
Expand Down Expand Up @@ -114,15 +128,113 @@ jobs:
event=tag,type=semver,pattern={{ version }}
env:
DOCKER_METADATA_PR_HEAD_SHA: true # set correct sha for PRs

- name: Prepare build args
id: args
run: |
{
echo "build-args<<EOF"
echo "IMAGE_VERSION=${{ steps.meta.outputs.version }}"
echo "${{ inputs.docker-build-args }}"
echo "EOF"
} >> "$GITHUB_OUTPUT"

- name: Build and push
uses: docker/build-push-action@v5
- name: Build and push by digest
uses: docker/build-push-action@v6
id: build
with:
context: ${{ inputs.docker-context }}
file: ${{ inputs.dockerfile-path }}
build-args: ${{ inputs.docker-build-args }}
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
file: ${{ inputs.docker-context }}/${{ inputs.dockerfile-path }}
platforms: ${{ matrix.platform }}
build-args: ${{ steps.args.outputs.build-args }}
cache-from: type=gha
cache-to: type=gha,mode=max
# don't specify 'tags' here (error "get can't push tagged ref by digest")
labels: ${{ steps.meta.outputs.labels }}
outputs: type=image,name=${{ env.IMAGE_NAME }},push-by-digest=true,name-canonical=true,push=true

- name: Export digest
run: |
mkdir -p /tmp/digests
digest="${{ steps.build.outputs.digest }}"
touch "/tmp/digests/${digest#sha256:}"

# HACK We upload the digest so the other jobs can reference the files properly, because there are no proper matrix job outputs
# https://github.com/orgs/community/discussions/26639#discussioncomment-3838014
- name: Upload digest
uses: actions/upload-artifact@v4
with:
name: digests-${{ matrix.platform == 'linux/amd64' && 'linux-amd64' || 'linux-arm64' }}
path: /tmp/digests/*
if-no-files-found: error
retention-days: 1

# publish merged manifest list of all previously build and pushed images
publish:
name: Publish Manifest List
needs:
- build-and-push
runs-on: ubuntu-latest
steps:
# We download the digest,because there are no proper outputs from the previous matrix job
# https://github.com/orgs/community/discussions/26639#discussioncomment-3838014
- name: Download digests
uses: actions/download-artifact@v4
with:
path: /tmp/digests
pattern: digests-*
merge-multiple: true

- name: Login to the Registry
uses: "docker/login-action@v3"
with:
registry: "${{ inputs.docker-registry }}"
username: "${{ secrets.docker-user }}"
password: "${{ secrets.docker-password }}"

- name: Set image name
run: |
fullImageName="${{ inputs.image-name }}"
if [[ -n "${{ inputs.image-namespace }}" ]]; then
fullImageName="${{ inputs.image-namespace }}/${fullImageName}"
fi
if [[ -n "${{ inputs.docker-registry }}" ]]; then
fullImageName="${{ inputs.docker-registry }}/${fullImageName}"
fi

echo "IMAGE_NAME=${fullImageName}" >> "$GITHUB_ENV"

- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3

- name: Collect Docker metadata
id: metadata
uses: docker/metadata-action@v5
with:
images: ${{ env.IMAGE_NAME }}
tags: |
event=push,type=raw,value=${{ inputs.image-tag }}
event=pr,type=raw,value=${{ inputs.image-tag }}
event=tag,type=semver,pattern={{ version }}
env:
DOCKER_METADATA_PR_HEAD_SHA: true # set correct sha for PRs

- name: Create and push merged manifest list
working-directory: /tmp/digests
run: |
# HACK that reads file names from downloaded artifacts as digest outputs from matrix jobs:
# https://github.com/orgs/community/discussions/26639#discussioncomment-3838014
images=()
for file in *; do
images+=("${{ env.IMAGE_NAME }}@sha256:${file}")
done

# read tags from metadata step output and create CLI params by adding -t for each tag
readarray -t tags < <(jq -cr '.tags | .[]' <<< "${DOCKER_METADATA_OUTPUT_JSON}")
tag_params=()
for tag in "${tags[@]}"; do
tag_params+=("-t")
tag_params+=("${tag}")
done

docker buildx imagetools create "${tag_params[@]}" "${images[@]}"
26 changes: 14 additions & 12 deletions docs/workflows/docker-build-and-publish/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,18 +49,20 @@ jobs:

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| ------------------- | ------- | -------- | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| checkout-lfs-files | boolean | false | `false` | Whether the Git checkout action should resolve LFS files or not. (Default is false) |
| checkout-submodules | string | false | `"false"` | Whether to checkout submodules: `true` to checkout submodules or `recursive` to recursively checkout submodules. |
| docker-build-args | string | false | | List of build-time variables (see https://github.com/docker/build-push-action?tab=readme-ov-file#inputs) |
| docker-context | string | false | `"."` | The docker context. |
| docker-registry | string | false | `"docker.io"` | Host where the image should be pushed to. |
| dockerfile-path | string | false | `"./Dockerfile"` | Path to the Dockerfile. |
| image-name | string | false | `"${{ github.event.repository.name }}"` | Name of Docker image. |
| image-namespace | string | false | `"bakdata"` | Namespace of Docker image. |
| image-tag | string | false | `"pipeline-${{ github.run_id }}-git-{{ sha }}"` | Tag of Docker image. |
| ref | string | false | | Ref name to checkout |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| ------------------- | ------- | -------- | ---------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| checkout-lfs-files | boolean | false | `false` | Whether the Git checkout action should resolve LFS files or not. (Default is false) |
| checkout-submodules | string | false | `"false"` | Whether to checkout submodules: `true` to checkout submodules or `recursive` to recursively checkout submodules. |
| docker-build-args | string | false | | List of build-time variables (see https://github.com/docker/build-push-action?tab=readme-ov-file#inputs) |
| docker-context | string | false | `"."` | The docker context. |
| docker-registry | string | false | `"docker.io"` | Host where the image should be pushed to. |
| dockerfile-path | string | false | `"./Dockerfile"` | Path to the Dockerfile. |
| image-name | string | false | `"${{ github.event.repository.name }}"` | Name of Docker image. |
| image-namespace | string | false | `"bakdata"` | Namespace of Docker image. |
| image-tag | string | false | `"pipeline-${{ github.run_id }}-git-{{ sha }}"` | Tag of Docker image. |
| platforms | string | false | `"['linux/amd64']"` | Architectures for the created image (comma separated) |
| ref | string | false | | Ref name to checkout |
| runs-on | string | false | `"{ 'linux/amd64': ['ubuntu-22.04'], 'linux/arm64': ['linux-arm-latest'] }"` | Runner config as JSON object string. Each key is one of the input `platforms` and each value is the list of runner tags on which the Docker image for that platform should be natively built on. Defaults to a mapping from expected possible `platforms` to GitHub runners native to that architecture. |

<!-- AUTO-DOC-INPUT:END -->

Expand Down
Loading