Merge pull request #542 from crazy-max/update-readme

Note about new inputs
This commit is contained in:
CrazyMax 2022-01-18 15:02:20 +01:00 committed by GitHub
commit 604f033158
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 33 additions and 23 deletions

View File

@ -4,10 +4,10 @@ on:
workflow_dispatch:
push:
branches:
- master
- 'master'
pull_request:
branches:
- master
- 'master'
jobs:
minimal:

View File

@ -6,7 +6,7 @@ on:
- cron: '0 10 * * *'
push:
branches:
- master
- 'master'
tags:
- v*

View File

@ -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

View File

@ -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:

View File

@ -12,7 +12,7 @@ name: ci
on:
push:
branches:
- 'master'
- 'main'
jobs:
docker:

View File

@ -10,7 +10,7 @@ name: ci
on:
push:
branches:
- 'master'
- 'main'
jobs:
docker:

View File

@ -9,7 +9,7 @@ name: ci
on:
push:
branches:
- 'master'
- 'main'
jobs:
docker:

View File

@ -6,7 +6,7 @@ name: ci
on:
push:
branches:
- 'master'
- 'main'
jobs:
docker:

View File

@ -8,7 +8,7 @@ name: ci
on:
push:
branches:
- 'master'
- 'main'
jobs:
docker:

View File

@ -12,7 +12,7 @@ name: ci
on:
push:
branches:
- 'master'
- 'main'
jobs:
docker:

View File

@ -14,7 +14,7 @@ name: ci
on:
push:
branches:
- 'master'
- 'main'
jobs:
docker:

View File

@ -22,7 +22,7 @@ name: ci
on:
push:
branches:
- 'master'
- 'main'
jobs:
docker:

View File

@ -11,7 +11,7 @@ name: ci
on:
push:
branches:
- 'master'
- 'main'
jobs:
build:

View File

@ -18,7 +18,7 @@ on:
- 'v*.*.*'
pull_request:
branches:
- 'master'
- 'main'
jobs:
docker:

View File

@ -14,7 +14,7 @@ name: ci
on:
push:
branches:
- 'master'
- 'main'
env:
TEST_TAG: user/myapp:test