File tree Expand file tree Collapse file tree 1 file changed +15
-5
lines changed Expand file tree Collapse file tree 1 file changed +15
-5
lines changed Original file line number Diff line number Diff line change @@ -17,6 +17,16 @@ Simplifies usage of [Docker Compose](https://docs.docker.com/compose/) for local
17
17
` composeLogs ` task stores logs from all containers to files in ` containerLogToDir ` directory.
18
18
19
19
## Quick start
20
+ The plugin is published to [ Gradle Plugin Portal] ( https://plugins.gradle.org/plugin/com.avast.gradle.docker-compose ) , so the import is easy as
21
+
22
+ ``` gradle
23
+ plugins {
24
+ id "com.avast.gradle.docker-compose" version "$versionHere"
25
+ }
26
+ ```
27
+
28
+ Since the version ` 0.14.2 ` , the plugin is also published to Maven Central, so if your prefer this way:
29
+
20
30
``` gradle
21
31
buildscript {
22
32
repositories {
@@ -28,14 +38,14 @@ buildscript {
28
38
}
29
39
30
40
apply plugin: 'docker-compose'
41
+ ```
31
42
32
- // Or use the new Gradle Portal plugins (then you don't have to add the dependency as above):
33
- // plugins {
34
- // id 'com.avast.gradle.docker-compose' version "$versionHere"
35
- // }
36
-
43
+ After importing the plugin, the basic usage is typically just:
44
+ ``` gradle
37
45
dockerCompose.isRequiredBy(test)
38
46
```
47
+
48
+ It ensures:
39
49
* ` docker-compose up ` is executed in the project directory, so it uses the ` docker-compose.yml ` file.
40
50
* If the provided task (` test ` in the example above) executes a new process then environment variables and Java system properties are provided.
41
51
* The name of environment variable is ` ${serviceName}_HOST ` and ` ${serviceName}_TCP_${exposedPort} ` (e.g. ` WEB_HOST ` and ` WEB_TCP_80 ` ).
You can’t perform that action at this time.
0 commit comments