From 5645ea727447501d9566ab7e67c88a6d634baa14 Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Tue, 18 Jan 2022 14:57:27 +0100 Subject: [PATCH] Note about new inputs Signed-off-by: CrazyMax --- .github/workflows/ci.yml | 4 ++-- .github/workflows/e2e.yml | 2 +- README.md | 20 +++++++++++++++----- docs/advanced/cache.md | 8 ++++---- docs/advanced/copy-between-registries.md | 2 +- docs/advanced/dockerhub-desc.md | 2 +- docs/advanced/export-docker.md | 2 +- docs/advanced/isolated-builders.md | 2 +- docs/advanced/local-registry.md | 2 +- docs/advanced/multi-platform.md | 2 +- docs/advanced/push-multi-registries.md | 2 +- docs/advanced/secrets.md | 2 +- docs/advanced/share-image-jobs.md | 2 +- docs/advanced/tags-labels.md | 2 +- docs/advanced/test-before-push.md | 2 +- 15 files changed, 33 insertions(+), 23 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2f6fbae..4b1e984 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -4,10 +4,10 @@ on: workflow_dispatch: push: branches: - - master + - 'master' pull_request: branches: - - master + - 'master' jobs: minimal: diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml index fd97e7c..b537054 100644 --- a/.github/workflows/e2e.yml +++ b/.github/workflows/e2e.yml @@ -6,7 +6,7 @@ on: - cron: '0 10 * * *' push: branches: - - master + - 'master' tags: - v* diff --git a/README.md b/README.md index 86c2a8d..96897a8 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ name: ci on: push: branches: - - 'master' + - 'main' jobs: docker: @@ -129,7 +129,7 @@ name: ci on: push: branches: - - 'master' + - 'main' jobs: docker: @@ -199,7 +199,7 @@ Following inputs can be used as `step.with` keys | `build-args` | List | List of build-time variables | | `cache-from` | List | List of [external cache sources](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#cache-from) (e.g., `type=local,src=path/to/dir`) | | `cache-to` | List | List of [cache export destinations](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#cache-to) (e.g., `type=local,dest=path/to/dir`) | -| `cgroup-parent` | String | Optional [parent cgroup](https://docs.docker.com/engine/reference/commandline/build/#use-a-custom-parent-cgroup---cgroup-parent) for the container used in the build | +| `cgroup-parent`¹ | String | Optional [parent cgroup](https://docs.docker.com/engine/reference/commandline/build/#use-a-custom-parent-cgroup---cgroup-parent) for the container used in the build | | `context` | String | Build's context is the set of files located in the specified [`PATH` or `URL`](https://docs.docker.com/engine/reference/commandline/build/) (default [Git context](#git-context)) | | `file` | String | Path to the Dockerfile. (default `{context}/Dockerfile`) | | `labels` | List | List of metadata for an image | @@ -212,11 +212,21 @@ Following inputs can be used as `step.with` keys | `push` | Bool | [Push](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#push) is a shorthand for `--output=type=registry` (default `false`) | | `secrets` | List | List of secrets to expose to the build (e.g., `key=string`, `GIT_AUTH_TOKEN=mytoken`) | | `secret-files` | List | List of secret files to expose to the build (e.g., `key=filename`, `MY_SECRET=./secret.txt`) | -| `shm-size` | String | Size of [`/dev/shm`](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#-size-of-devshm---shm-size) (e.g., `2g`) | +| `shm-size`¹ | String | Size of [`/dev/shm`](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#-size-of-devshm---shm-size) (e.g., `2g`) | | `ssh` | List | List of SSH agent socket or keys to expose to the build | | `tags` | List/CSV | List of tags | | `target` | String | Sets the target stage to build | -| `ulimit` | List | [Ulimit](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#-set-ulimits---ulimit) options (e.g., `nofile=1024:1024`) | +| `ulimit`¹ | List | [Ulimit](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#-set-ulimits---ulimit) options (e.g., `nofile=1024:1024`) | + +> ¹ `cgroup-parent`, `shm-size` and `ulimit` are only available using `moby/buildkit:master` +> as builder image atm: +> ```yaml +> - name: Set up Docker Buildx +> uses: docker/setup-buildx-action@v1 +> with: +> driver-opts: | +> image=moby/buildkit:master +> ``` ### outputs diff --git a/docs/advanced/cache.md b/docs/advanced/cache.md index 6b5502e..96d6787 100644 --- a/docs/advanced/cache.md +++ b/docs/advanced/cache.md @@ -20,7 +20,7 @@ name: ci on: push: branches: - - 'master' + - 'main' jobs: docker: @@ -60,7 +60,7 @@ name: ci on: push: branches: - - 'master' + - 'main' jobs: docker: @@ -110,7 +110,7 @@ name: ci on: push: branches: - - 'master' + - 'main' jobs: docker: @@ -154,7 +154,7 @@ name: ci on: push: branches: - - 'master' + - 'main' jobs: docker: diff --git a/docs/advanced/copy-between-registries.md b/docs/advanced/copy-between-registries.md index 8d68ed4..a458213 100644 --- a/docs/advanced/copy-between-registries.md +++ b/docs/advanced/copy-between-registries.md @@ -12,7 +12,7 @@ name: ci on: push: branches: - - 'master' + - 'main' jobs: docker: diff --git a/docs/advanced/dockerhub-desc.md b/docs/advanced/dockerhub-desc.md index 96fc623..86d1d15 100644 --- a/docs/advanced/dockerhub-desc.md +++ b/docs/advanced/dockerhub-desc.md @@ -10,7 +10,7 @@ name: ci on: push: branches: - - 'master' + - 'main' jobs: docker: diff --git a/docs/advanced/export-docker.md b/docs/advanced/export-docker.md index db941fe..b9a2f71 100644 --- a/docs/advanced/export-docker.md +++ b/docs/advanced/export-docker.md @@ -9,7 +9,7 @@ name: ci on: push: branches: - - 'master' + - 'main' jobs: docker: diff --git a/docs/advanced/isolated-builders.md b/docs/advanced/isolated-builders.md index 82bed1e..888cc88 100644 --- a/docs/advanced/isolated-builders.md +++ b/docs/advanced/isolated-builders.md @@ -6,7 +6,7 @@ name: ci on: push: branches: - - 'master' + - 'main' jobs: docker: diff --git a/docs/advanced/local-registry.md b/docs/advanced/local-registry.md index 7f341a2..090ae68 100644 --- a/docs/advanced/local-registry.md +++ b/docs/advanced/local-registry.md @@ -8,7 +8,7 @@ name: ci on: push: branches: - - 'master' + - 'main' jobs: docker: diff --git a/docs/advanced/multi-platform.md b/docs/advanced/multi-platform.md index 9e9e329..4ef94c5 100644 --- a/docs/advanced/multi-platform.md +++ b/docs/advanced/multi-platform.md @@ -12,7 +12,7 @@ name: ci on: push: branches: - - 'master' + - 'main' jobs: docker: diff --git a/docs/advanced/push-multi-registries.md b/docs/advanced/push-multi-registries.md index e4dd8ab..b2aa586 100644 --- a/docs/advanced/push-multi-registries.md +++ b/docs/advanced/push-multi-registries.md @@ -14,7 +14,7 @@ name: ci on: push: branches: - - 'master' + - 'main' jobs: docker: diff --git a/docs/advanced/secrets.md b/docs/advanced/secrets.md index 0879fdf..d7dc54f 100644 --- a/docs/advanced/secrets.md +++ b/docs/advanced/secrets.md @@ -22,7 +22,7 @@ name: ci on: push: branches: - - 'master' + - 'main' jobs: docker: diff --git a/docs/advanced/share-image-jobs.md b/docs/advanced/share-image-jobs.md index 3421bd6..b6687e1 100644 --- a/docs/advanced/share-image-jobs.md +++ b/docs/advanced/share-image-jobs.md @@ -11,7 +11,7 @@ name: ci on: push: branches: - - 'master' + - 'main' jobs: build: diff --git a/docs/advanced/tags-labels.md b/docs/advanced/tags-labels.md index 82ef9d8..594d37b 100644 --- a/docs/advanced/tags-labels.md +++ b/docs/advanced/tags-labels.md @@ -18,7 +18,7 @@ on: - 'v*.*.*' pull_request: branches: - - 'master' + - 'main' jobs: docker: diff --git a/docs/advanced/test-before-push.md b/docs/advanced/test-before-push.md index 6ee9ada..48b0f8a 100644 --- a/docs/advanced/test-before-push.md +++ b/docs/advanced/test-before-push.md @@ -14,7 +14,7 @@ name: ci on: push: branches: - - 'master' + - 'main' env: TEST_TAG: user/myapp:test