Skip to content

Commit ee76101

Browse files
committed
docs: default for useDockerComposeV2
1 parent 38a1e72 commit ee76101

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,9 @@ dockerCompose {
115115
116116
projectName = 'my-project' // allow to set custom docker-compose project name (defaults to a stable name derived from absolute path of the project and nested settings name), set to null to Docker Compose default (directory name)
117117
projectNamePrefix = 'my_prefix_' // allow to set custom prefix of docker-compose project name, the final project name has nested configuration name appended
118-
executable = '/path/to/docker-compose' // allow to set the path of the docker-compose executable (useful if not present in PATH)
118+
executable = '/path/to/docker-compose' // allow to set the path of the docker-compose executable (useful if not present in PATH). Not used if useDockerComposeV2 is set to true.
119119
dockerExecutable = '/path/to/docker' // allow to set the path of the docker executable (useful if not present in PATH)
120-
useDockerComposeV2 = true // Use Docker Compose V2 instead of Docker Compose V1. All invocations will be done using `docker compose` instead of `docker-compose`.
120+
useDockerComposeV2 = true // Use Docker Compose V2 instead of Docker Compose V1. All invocations will be done using `docker compose` instead of `docker-compose`. Default is false.
121121
dockerComposeWorkingDirectory = project.file('/path/where/docker-compose/is/invoked/from')
122122
dockerComposeStopTimeout = java.time.Duration.ofSeconds(20) // time before docker-compose sends SIGTERM to the running containers after the composeDown task has been started
123123
environment.put 'BACKEND_ADDRESS', '192.168.1.100' // environment variables to be used when calling 'docker-compose', e.g. for substitution in compose file

0 commit comments

Comments
 (0)