Skip to content

Commit

Permalink
Update Docker Workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
yordanovsstoyan committed Sep 17, 2024
1 parent 2d21679 commit 2345693
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 12 deletions.
5 changes: 5 additions & 0 deletions .github/workflows/docker-build-and-publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ 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

secrets:
docker-user:
Expand Down
25 changes: 13 additions & 12 deletions docs/workflows/docker-build-and-publish/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,18 +49,19 @@ 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. |
| 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

0 comments on commit 2345693

Please sign in to comment.