Add support to pass env-file to docker compose run #9169

KoditkarVedant · 2022-02-13T20:35:33Z

What I did
This pull request adds support to pass in --env-file to docker compose run command.

Behavior of the option:
If you pass env-file from CLI it overrides the env-files provided in docker-compose.yaml config.

Related issue
#8379

(not mandatory) A picture of a cute animal, if possible in relation with what you did

ndeloof · 2022-03-01T08:27:12Z

command documentation also need to be updated to reflect this new flag: https://github.com/docker/compose/blob/v2/docs/reference/docker_compose_run.yaml

KoditkarVedant · 2022-03-02T16:16:45Z

@ndeloof Looks like there is bug in the implementation. It isn't working as expected. I think when we parse the compose config files at that time only the env_file mentioned in it gets parsed. because when I see the service.Environment it was already populated with the key=value mentioned in the env_file. So my understanding that just replacing the service.EnvFile will work is not true.

I'll just put back this PR in draft as it is not ready for merge.

ndeloof · 2022-03-11T13:09:59Z

The main issue I see adding support for compose run --env-file ... to set container environment from a file (which would make sense to align with docker run ...) is that this will introduce confusion with the top-level --env-file used to override .env file used to interpolate variables. i.e.
docker compose --env-file xx run is a distinct thing vs docker compose run --env-file xx
I'm not sure how we could address this UX issue. Any thoughts @glours @ulyssessouza @thaJeztah ?

ulyssessouza · 2022-07-13T03:17:46Z

Same for me... The UX doesn't help... And specially because the new one is an array and the root command one is a single file.

ndeloof · 2023-01-18T08:56:48Z

cmd/compose/run.go

@@ -141,6 +142,7 @@ func runCommand(p *projectOptions, backend api.Service) *cobra.Command {
 	flags := cmd.Flags()
 	flags.BoolVarP(&opts.Detach, "detach", "d", false, "Run container in background and print container ID")
 	flags.StringArrayVarP(&opts.environment, "env", "e", []string{}, "Set environment variables")
+	flags.StringArrayVar(&opts.EnvFiles, "env-file", []string{}, "Read in a file of environment variables")


I suggest we use --service-env-file to avoid ambiguity with upper-level compose command --env-file flag

If we want to retain a parallel between docker run and docker compose run, then I'm wondering if we should look at doing the reverse, and think of a new name for the flag for setting the .env (we could keep the old flag, but hidden)

renamed the option to service-env-file

Signed-off-by: Vedant Koditkar <vedant.koditkar@outlook.com>

ndeloof

LGTM but path to service env file passed by command line flag could be relative to working directory

ndeloof · 2023-01-24T18:02:47Z

pkg/compose/run.go

@@ -127,4 +127,8 @@ func applyRunOptions(project *types.Project, service *types.ServiceConfig, opts
 	for k, v := range opts.Labels {
 		service.Labels = service.Labels.Add(k, v)
 	}
+
+	if opts.ServiceEnvFiles != nil {
+		service.EnvFile = append(service.EnvFile, opts.ServiceEnvFiles...)


need to make service envfile an absolute path

is there any sample code which I can refer in the repository?

You can just use:

if !filepath.IsAbs(file) { file, err = filepath.Abs(file) }

codecov · 2023-01-24T18:12:20Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.89%. Comparing base (d47f0f3) to head (bfb8c20).
Report is 1126 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #9169   +/-   ##
=======================================
  Coverage   73.89%   73.89%           
=======================================
  Files           2        2           
  Lines         272      272           
=======================================
  Hits          201      201           
  Misses         60       60           
  Partials       11       11

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ndeloof · 2024-10-15T15:48:31Z

cmd/compose/run.go

@@ -156,6 +157,7 @@ func runCommand(p *ProjectOptions, streams api.Streams, backend api.Service) *co
 	flags := cmd.Flags()
 	flags.BoolVarP(&opts.Detach, "detach", "d", false, "Run container in background and print container ID")
 	flags.StringArrayVarP(&opts.environment, "env", "e", []string{}, "Set environment variables")
+	flags.StringArrayVar(&opts.ServiceEnvFiles, "service-env-file", []string{}, "Read in a file of environment variables")


Suggestion: rename flag --env-from-file, wdyt ?

KoditkarVedant force-pushed the 8379-support-env-file-in-docker-compose-run-command branch from 25c370a to 5a1f2bd Compare February 13, 2022 20:39

KoditkarVedant marked this pull request as ready for review February 26, 2022 04:39

ndeloof approved these changes Feb 28, 2022

View reviewed changes

KoditkarVedant marked this pull request as draft March 2, 2022 16:16

reggermont mentioned this pull request Jan 17, 2023

support --env-file in docker-compose run command #8379

Open

ndeloof reviewed Jan 18, 2023

View reviewed changes

KoditkarVedant requested review from ndeloof and thaJeztah and removed request for ndeloof January 24, 2023 17:40

KoditkarVedant marked this pull request as ready for review January 24, 2023 17:41

KoditkarVedant force-pushed the 8379-support-env-file-in-docker-compose-run-command branch from a877dc5 to 5b7b2a3 Compare January 24, 2023 17:50

KoditkarVedant added 2 commits January 24, 2023 23:21

Add support to pass env-file to docker compose run

d6e806a

Signed-off-by: Vedant Koditkar <vedant.koditkar@outlook.com>

Add service-env-file option to pass service env file

bfb8c20

Signed-off-by: Vedant Koditkar <vedant.koditkar@outlook.com>

KoditkarVedant force-pushed the 8379-support-env-file-in-docker-compose-run-command branch from 5b7b2a3 to bfb8c20 Compare January 24, 2023 17:51

ndeloof requested changes Jan 24, 2023

View reviewed changes

ndeloof reviewed Oct 15, 2024

View reviewed changes

github-actions bot added the stale label Dec 15, 2024

github-actions bot closed this Dec 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support to pass env-file to docker compose run #9169

Add support to pass env-file to docker compose run #9169

KoditkarVedant commented Feb 13, 2022

ndeloof commented Mar 1, 2022

KoditkarVedant commented Mar 2, 2022

ndeloof commented Mar 11, 2022

ulyssessouza commented Jul 13, 2022

ndeloof Jan 18, 2023

thaJeztah Jan 18, 2023

KoditkarVedant Jan 24, 2023

ndeloof left a comment

ndeloof Jan 24, 2023

KoditkarVedant Jan 29, 2023

ndeloof May 10, 2023 •

edited

Loading

codecov bot commented Jan 24, 2023 •

edited

Loading

ndeloof Oct 15, 2024

Add support to pass env-file to docker compose run #9169

Add support to pass env-file to docker compose run #9169

Conversation

KoditkarVedant commented Feb 13, 2022

ndeloof commented Mar 1, 2022

KoditkarVedant commented Mar 2, 2022

ndeloof commented Mar 11, 2022

ulyssessouza commented Jul 13, 2022

ndeloof Jan 18, 2023

Choose a reason for hiding this comment

thaJeztah Jan 18, 2023

Choose a reason for hiding this comment

KoditkarVedant Jan 24, 2023

Choose a reason for hiding this comment

ndeloof left a comment

Choose a reason for hiding this comment

ndeloof Jan 24, 2023

Choose a reason for hiding this comment

KoditkarVedant Jan 29, 2023

Choose a reason for hiding this comment

ndeloof May 10, 2023 • edited Loading

Choose a reason for hiding this comment

codecov bot commented Jan 24, 2023 • edited Loading

Codecov Report

ndeloof Oct 15, 2024

Choose a reason for hiding this comment

ndeloof May 10, 2023 •

edited

Loading

codecov bot commented Jan 24, 2023 •

edited

Loading