From d84512ea9fb5272b305c3ecf9ef3f602ab2b2176 Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Sun, 27 Feb 2022 22:11:26 +0100 Subject: [PATCH] docs: additional info for iidfile flag Signed-off-by: CrazyMax --- commands/build.go | 2 +- docs/reference/buildx_build.md | 12 +++++++++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/commands/build.go b/commands/build.go index f63214b4..67af1862 100644 --- a/commands/build.go +++ b/commands/build.go @@ -357,7 +357,7 @@ func buildCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command { flags.StringVarP(&options.dockerfileName, "file", "f", "", `Name of the Dockerfile (default: "PATH/Dockerfile")`) flags.SetAnnotation("file", annotation.ExternalURL, []string{"https://docs.docker.com/engine/reference/commandline/build/#specify-a-dockerfile--f"}) - flags.StringVar(&options.imageIDFile, "iidfile", "", "Write the image ID to the file") + flags.StringVar(&options.imageIDFile, "iidfile", "", "Write the image ID or digest to the file") flags.StringArrayVar(&options.labels, "label", []string{}, "Set metadata for an image") diff --git a/docs/reference/buildx_build.md b/docs/reference/buildx_build.md index 2a8339d3..a816bf50 100644 --- a/docs/reference/buildx_build.md +++ b/docs/reference/buildx_build.md @@ -24,7 +24,7 @@ Start a build | [`--cache-to`](#cache-to) | `stringArray` | | Cache export destinations (e.g., `user/app:cache`, `type=local,dest=path/to/dir`) | | [`--cgroup-parent`](https://docs.docker.com/engine/reference/commandline/build/#use-a-custom-parent-cgroup---cgroup-parent) | `string` | | Optional parent cgroup for the container | | [`-f`](https://docs.docker.com/engine/reference/commandline/build/#specify-a-dockerfile--f), [`--file`](https://docs.docker.com/engine/reference/commandline/build/#specify-a-dockerfile--f) | `string` | | Name of the Dockerfile (default: `PATH/Dockerfile`) | -| `--iidfile` | `string` | | Write the image ID to the file | +| [`--iidfile`](#iidfile) | `string` | | Write the image ID or digest to the file | | `--label` | `stringArray` | | Set metadata for an image | | [`--load`](#load) | | | Shorthand for `--output=type=docker` | | [`--metadata-file`](#metadata-file) | `string` | | Write build result metadata to the file | @@ -210,6 +210,16 @@ $ docker buildx build --cache-to=type=gha . More info about cache exporters and available attributes: https://github.com/moby/buildkit#export-cache +### Write the image ID or digest to the file (--iidfile) + +Output the image ID or digest depending on the driver and output being used to +the specified file: + +* `docker` driver : writes the image ID. +* `docker` driver with `--push`: writes the image digest. +* `docker-container` driver with `--load`: writes the image ID. +* `docker-container` driver with `--push`: writes the image digest. + ### Load the single-platform build result to `docker images` (--load) Shorthand for [`--output=type=docker`](#docker). Will automatically load the