From bd8e57447a3456cac3f323e7736d769b4f5d3eed Mon Sep 17 00:00:00 2001 From: Matt Armand Date: Wed, 11 Jan 2023 10:19:02 -0500 Subject: [PATCH 1/4] Add remove-orphans functionality to run, because it recommends that in error messages Signed-off-by: Matt Armand --- cmd/compose/run.go | 1 + docs/reference/compose_run.md | 1 + docs/reference/docker_compose_run.yaml | 11 ++++++++++- 3 files changed, 12 insertions(+), 1 deletion(-) diff --git a/cmd/compose/run.go b/cmd/compose/run.go index 344ee50c7..9ae5d7d88 100644 --- a/cmd/compose/run.go +++ b/cmd/compose/run.go @@ -162,6 +162,7 @@ func runCommand(p *ProjectOptions, streams api.Streams, backend api.Service) *co flags.BoolVar(&opts.servicePorts, "service-ports", false, "Run command with the service's ports enabled and mapped to the host.") flags.BoolVar(&opts.quietPull, "quiet-pull", false, "Pull without printing progress information.") flags.BoolVar(&createOpts.Build, "build", false, "Build image before starting container.") + flags.BoolVar(&opts.removeOrphans, "remove-orphans", false, "Remove containers for services not defined in the Compose file.") cmd.Flags().BoolVarP(&opts.interactive, "interactive", "i", true, "Keep STDIN open even if not attached.") cmd.Flags().BoolP("tty", "t", true, "Allocate a pseudo-TTY.") diff --git a/docs/reference/compose_run.md b/docs/reference/compose_run.md index a870a9067..3c924ea29 100644 --- a/docs/reference/compose_run.md +++ b/docs/reference/compose_run.md @@ -24,6 +24,7 @@ Run a one-off command on a service. | `-u`, `--user` | `string` | | Run as specified username or uid | | `-v`, `--volume` | `stringArray` | | Bind mount a volume. | | `-w`, `--workdir` | `string` | | Working directory inside the container | +| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | diff --git a/docs/reference/docker_compose_run.yaml b/docs/reference/docker_compose_run.yaml index 9d5715f4e..8ac5f1c35 100644 --- a/docs/reference/docker_compose_run.yaml +++ b/docs/reference/docker_compose_run.yaml @@ -246,9 +246,18 @@ options: experimentalcli: false kubernetes: false swarm: false + - option: remove-orphans + value_type: bool + default_value: "false" + description: Remove containers for services not defined in the Compose file. + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: false kubernetes: false swarm: false - From 4cebce3a5c4f38a113f73038f6f83b27efba4bd9 Mon Sep 17 00:00:00 2001 From: Matt Armand Date: Wed, 11 Jan 2023 12:07:51 -0500 Subject: [PATCH 2/4] This option lives in the create options, not the run options Signed-off-by: Matt Armand --- cmd/compose/run.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/compose/run.go b/cmd/compose/run.go index 9ae5d7d88..f66ad557f 100644 --- a/cmd/compose/run.go +++ b/cmd/compose/run.go @@ -162,7 +162,7 @@ func runCommand(p *ProjectOptions, streams api.Streams, backend api.Service) *co flags.BoolVar(&opts.servicePorts, "service-ports", false, "Run command with the service's ports enabled and mapped to the host.") flags.BoolVar(&opts.quietPull, "quiet-pull", false, "Pull without printing progress information.") flags.BoolVar(&createOpts.Build, "build", false, "Build image before starting container.") - flags.BoolVar(&opts.removeOrphans, "remove-orphans", false, "Remove containers for services not defined in the Compose file.") + flags.BoolVar(&createOpts.removeOrphans, "remove-orphans", false, "Remove containers for services not defined in the Compose file.") cmd.Flags().BoolVarP(&opts.interactive, "interactive", "i", true, "Keep STDIN open even if not attached.") cmd.Flags().BoolP("tty", "t", true, "Allocate a pseudo-TTY.") From 1adc9f54d5a46a410f4280635cf7ed5dc752f597 Mon Sep 17 00:00:00 2001 From: Matt Armand Date: Wed, 11 Jan 2023 12:24:15 -0500 Subject: [PATCH 3/4] fix docs yaml Signed-off-by: Matt Armand --- docs/reference/docker_compose_run.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/reference/docker_compose_run.yaml b/docs/reference/docker_compose_run.yaml index 8ac5f1c35..33d416da3 100644 --- a/docs/reference/docker_compose_run.yaml +++ b/docs/reference/docker_compose_run.yaml @@ -261,3 +261,4 @@ experimental: false experimentalcli: false kubernetes: false swarm: false + From dadad01e6351b723b6849dbc75d7bebd5dea389e Mon Sep 17 00:00:00 2001 From: Matt Armand Date: Wed, 11 Jan 2023 13:20:30 -0500 Subject: [PATCH 4/4] Update docs programatically like you're supposed to Signed-off-by: Matt Armand --- docs/reference/compose_run.md | 2 +- docs/reference/docker_compose_run.yaml | 20 ++++++++++---------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/reference/compose_run.md b/docs/reference/compose_run.md index 3c924ea29..012a87e36 100644 --- a/docs/reference/compose_run.md +++ b/docs/reference/compose_run.md @@ -18,13 +18,13 @@ Run a one-off command on a service. | `--no-deps` | | | Don't start linked services. | | `-p`, `--publish` | `stringArray` | | Publish a container's port(s) to the host. | | `--quiet-pull` | | | Pull without printing progress information. | +| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | | `--rm` | | | Automatically remove the container when it exits | | `--service-ports` | | | Run command with the service's ports enabled and mapped to the host. | | `--use-aliases` | | | Use the service's network useAliases in the network(s) the container connects to. | | `-u`, `--user` | `string` | | Run as specified username or uid | | `-v`, `--volume` | `stringArray` | | Bind mount a volume. | | `-w`, `--workdir` | `string` | | Working directory inside the container | -| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. | diff --git a/docs/reference/docker_compose_run.yaml b/docs/reference/docker_compose_run.yaml index 33d416da3..97066f123 100644 --- a/docs/reference/docker_compose_run.yaml +++ b/docs/reference/docker_compose_run.yaml @@ -172,6 +172,16 @@ options: experimentalcli: false kubernetes: false swarm: false + - option: remove-orphans + value_type: bool + default_value: "false" + description: Remove containers for services not defined in the Compose file. + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: rm value_type: bool default_value: "false" @@ -246,16 +256,6 @@ options: experimentalcli: false kubernetes: false swarm: false - - option: remove-orphans - value_type: bool - default_value: "false" - description: Remove containers for services not defined in the Compose file. - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false deprecated: false experimental: false experimentalcli: false