From 7320062dfe3a461d72770061303c3003af9421ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Gronowski?= Date: Tue, 9 Jul 2024 15:35:36 +0200 Subject: [PATCH] push: Improve note message and colors MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Paweł Gronowski --- cli/command/image/push.go | 29 ++++++++++++++++++------ docs/reference/commandline/image_push.md | 12 +++++----- docs/reference/commandline/push.md | 12 +++++----- 3 files changed, 34 insertions(+), 19 deletions(-) diff --git a/cli/command/image/push.go b/cli/command/image/push.go index 51c4a34528fd..d28fd93e7a41 100644 --- a/cli/command/image/push.go +++ b/cli/command/image/push.go @@ -8,6 +8,7 @@ import ( "encoding/json" "fmt" "io" + "strings" "github.com/containerd/platforms" "github.com/distribution/reference" @@ -63,6 +64,7 @@ func NewPushCommand(dockerCli command.Cli) *cobra.Command { // on older APIs which don't support it. flags.StringVar(&opts.platform, "platform", "", `Push a platform-specific manifest as a single-platform image to the registry. +Image index won't be pushed, meaning that other manifests, including attestations won't be preserved. 'os[/arch[/variant]]': Explicit platform (eg. linux/amd64)`) flags.SetAnnotation("platform", "version", []string{"1.46"}) @@ -82,9 +84,9 @@ func RunPush(ctx context.Context, dockerCli command.Cli, opts pushOptions) error } platform = &p - printNote(dockerCli, `Selecting a single platform will only push one matching image manifest from a multi-platform image index. -This means that any other components attached to the multi-platform image index (like Buildkit attestations) won't be pushed. -If you want to push a whole multi-platform image, make sure all image content is present and remove the --platform flag. + printNote(dockerCli, `Using --platform pushes only the specified platform manifest of a multi-platform image index. +Other components, like attestations, will not be included. +To push the complete multi-platform image, remove the --platform flag. `) } @@ -182,9 +184,22 @@ func handleAux(dockerCli command.Cli) func(jm jsonmessage.JSONMessage) { func printNote(dockerCli command.Cli, format string, args ...any) { if dockerCli.Err().IsTerminal() { - _, _ = fmt.Fprint(dockerCli.Err(), aec.WhiteF.Apply(aec.CyanB.Apply("[ NOTE ]"))+" ") - } else { - _, _ = fmt.Fprint(dockerCli.Err(), "[ NOTE ] ") + format = strings.ReplaceAll(format, "--platform", aec.Bold.Apply("--platform")) + } + + header := " Info -> " + padding := len(header) + if dockerCli.Err().IsTerminal() { + padding = len("i Info > ") + header = aec.Bold.Apply(aec.LightCyanB.Apply(aec.BlackF.Apply("i")) + " " + aec.LightCyanF.Apply("Info → ")) + } + + _, _ = fmt.Fprint(dockerCli.Err(), header) + s := fmt.Sprintf(format, args...) + for idx, line := range strings.Split(s, "\n") { + if idx > 0 { + _, _ = fmt.Fprint(dockerCli.Err(), strings.Repeat(" ", padding)) + } + _, _ = fmt.Fprintln(dockerCli.Err(), aec.Italic.Apply(line)) } - _, _ = fmt.Fprintf(dockerCli.Err(), aec.Bold.Apply(format)+"\n", args...) } diff --git a/docs/reference/commandline/image_push.md b/docs/reference/commandline/image_push.md index d58282a1accc..bdcb90274554 100644 --- a/docs/reference/commandline/image_push.md +++ b/docs/reference/commandline/image_push.md @@ -9,12 +9,12 @@ Upload an image to a registry ### Options -| Name | Type | Default | Description | -|:---------------------------------------------|:---------|:--------|:--------------------------------------------------------------------------------------------------------------------------------------------| -| [`-a`](#all-tags), [`--all-tags`](#all-tags) | `bool` | | Push all tags of an image to the repository | -| `--disable-content-trust` | `bool` | `true` | Skip image signing | -| `--platform` | `string` | | Push a platform-specific manifest as a single-platform image to the registry.
'os[/arch[/variant]]': Explicit platform (eg. linux/amd64) | -| `-q`, `--quiet` | `bool` | | Suppress verbose output | +| Name | Type | Default | Description | +|:---------------------------------------------|:---------|:--------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`-a`](#all-tags), [`--all-tags`](#all-tags) | `bool` | | Push all tags of an image to the repository | +| `--disable-content-trust` | `bool` | `true` | Skip image signing | +| `--platform` | `string` | | Push a platform-specific manifest as a single-platform image to the registry.
Image index won't be pushed, meaning that other manifests, including attestations will be lost.
'os[/arch[/variant]]': Explicit platform (eg. linux/amd64) | +| `-q`, `--quiet` | `bool` | | Suppress verbose output | diff --git a/docs/reference/commandline/push.md b/docs/reference/commandline/push.md index 2d8358d6ff7f..cfd178cfa728 100644 --- a/docs/reference/commandline/push.md +++ b/docs/reference/commandline/push.md @@ -9,12 +9,12 @@ Upload an image to a registry ### Options -| Name | Type | Default | Description | -|:--------------------------|:---------|:--------|:--------------------------------------------------------------------------------------------------------------------------------------------| -| `-a`, `--all-tags` | `bool` | | Push all tags of an image to the repository | -| `--disable-content-trust` | `bool` | `true` | Skip image signing | -| `--platform` | `string` | | Push a platform-specific manifest as a single-platform image to the registry.
'os[/arch[/variant]]': Explicit platform (eg. linux/amd64) | -| `-q`, `--quiet` | `bool` | | Suppress verbose output | +| Name | Type | Default | Description | +|:--------------------------|:---------|:--------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `-a`, `--all-tags` | `bool` | | Push all tags of an image to the repository | +| `--disable-content-trust` | `bool` | `true` | Skip image signing | +| `--platform` | `string` | | Push a platform-specific manifest as a single-platform image to the registry.
Image index won't be pushed, meaning that other manifests, including attestations will be lost.
'os[/arch[/variant]]': Explicit platform (eg. linux/amd64) | +| `-q`, `--quiet` | `bool` | | Suppress verbose output |