Merge pull request #1215 from crazy-max/docs-fix-bake-fields

docs(bake): fix target fields and show type
pull/1129/head
CrazyMax 2 years ago committed by GitHub
commit ec1ba14f3e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -40,23 +40,26 @@ $ docker buildx bake webapp-dev
Complete list of valid target fields available for [HCL](#hcl-definition) and Complete list of valid target fields available for [HCL](#hcl-definition) and
[JSON](#json-definition) definitions: [JSON](#json-definition) definitions:
* `args` | Name | Type | Description |
* `cache-from` |---------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------|
* `cache-to` | `inherits` | List | [Inherit build options](#merging-and-inheritance) from other targets |
* `context` | `args` | Map | Set build-time variables (same as [`--build-arg` flag](https://docs.docker.com/engine/reference/commandline/buildx_build/)) |
* `contexts` | `cache-from` | List | External cache sources (same as [`--cache-from` flag](https://docs.docker.com/engine/reference/commandline/buildx_build/)) |
* `dockerfile` | `cache-to` | List | Cache export destinations (same as [`--cache-to` flag](https://docs.docker.com/engine/reference/commandline/buildx_build/)) |
* `inherits` | `context` | String | Set of files located in the specified path or URL |
* `labels` | `contexts` | Map | Additional build contexts (same as [`--build-context` flag](https://docs.docker.com/engine/reference/commandline/buildx_build/)) |
* `no-cache` | `dockerfile` | String | Name of the Dockerfile (same as [`--file` flag](https://docs.docker.com/engine/reference/commandline/buildx_build/)) |
* `no-cache-filter` | `dockerfile-inline` | String | Inline Dockerfile content |
* `output` | `labels` | Map | Set metadata for an image (same as [`--label` flag](https://docs.docker.com/engine/reference/commandline/buildx_build/)) |
* `platform` | `no-cache` | Bool | Do not use cache when building the image (same as [`--no-cache` flag](https://docs.docker.com/engine/reference/commandline/buildx_build/)) |
* `pull` | `no-cache-filter` | List | Do not cache specified stages (same as [`--no-cache-filter` flag](https://docs.docker.com/engine/reference/commandline/buildx_build/)) |
* `secrets` | `output` | List | Output destination (same as [`--output` flag](https://docs.docker.com/engine/reference/commandline/buildx_build/)) |
* `ssh` | `platforms` | List | Set target platforms for build (same as [`--platform` flag](https://docs.docker.com/engine/reference/commandline/buildx_build/)) |
* `tags` | `pull` | Bool | Always attempt to pull all referenced images (same as [`--pull` flag](https://docs.docker.com/engine/reference/commandline/buildx_build/)) |
* `target` | `secret` | List | Secret to expose to the build (same as [`--secret` flag](https://docs.docker.com/engine/reference/commandline/buildx_build/)) |
| `ssh` | List | SSH agent socket or keys to expose to the build (same as [`--ssh` flag](https://docs.docker.com/engine/reference/commandline/buildx_build/)) |
| `tags` | List | Name and optionally a tag in the format `name:tag` (same as [`--tag` flag](https://docs.docker.com/engine/reference/commandline/buildx_build/)) |
| `target` | String | Set the target build stage to build (same as [`--target` flag](https://docs.docker.com/engine/reference/commandline/buildx_build/)) |
### Group ### Group

@ -153,9 +153,11 @@ Complete list of overridable fields:
* `dockerfile` * `dockerfile`
* `labels` * `labels`
* `no-cache` * `no-cache`
* `no-cache-filter`
* `output` * `output`
* `platform` * `platform`
* `pull` * `pull`
* `push`
* `secrets` * `secrets`
* `ssh` * `ssh`
* `tags` * `tags`

Loading…
Cancel
Save