Merge pull request #488 from buildkite-plugins/toote_minor_changes

Minor changes

Author: pzeballos

README.md

@@ -13,6 +13,8 @@ You can learn a lot about how this plugin is used by browsing the [documentation
 
 ## Configuration
 
+Important: this plugin assumes that your docker compose file is called `docker-compose.yml`. If your file is called diferently, make sure to set plugin's `config` option or - more generally - set the pipeline-level environment variable `COMPOSE_FILE` with the right value. This is due to the possible usage of a custom-named override files in some situations and can not be worked around due to limitations of docker's `-f` option.
+
 ### Main Commands
 
 You will need to specify at least one of the following to use this extension.

docs/examples.md

@@ -10,7 +10,7 @@ The following pipeline will run `test.sh` inside a `app` service container using
 steps:
   - command: test.sh
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           run: app
 ```
 
@@ -19,7 +19,7 @@ steps:
 ```yml
 steps:
   - plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           run: app
           command: ["custom", "command", "values"]
 ```
@@ -31,7 +31,7 @@ The plugin will honor the value of the `COMPOSE_FILE` environment variable if on
 steps:
   - command: test.sh
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           run: app
           config: docker-compose.tests.yml
           env:
@@ -47,15 +47,15 @@ steps:
   - plugins:
       - docker-login#v2.0.1:
           username: xyz
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           build: app
           push: app:index.docker.io/myorg/myrepo:tag
   - wait
   - command: test.sh
     plugins:
       - docker-login#v2.0.1:
           username: xyz
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           run: app
 ```
 
@@ -72,7 +72,7 @@ steps:
   - command: generate-dist.sh
     artifact_paths: "dist/*"
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           run: app
           volumes:
             - "./dist:/folder/dist"
@@ -96,7 +96,7 @@ this plugin offers a `environment` block of its own:
 steps:
   - command: generate-dist.sh
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           run: app
           env:
             - BUILDKITE_BUILD_NUMBER
@@ -114,7 +114,7 @@ Alternatively, you can have the plugin add all environment variables defined for
 steps:
   - command: use-vars.sh
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           run: app
           propagate-environment: true
 ```
@@ -130,7 +130,7 @@ steps:
     env:
       COMPOSE_PROFILES: "frontend,debug"
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           run: app
 ```
 
@@ -167,7 +167,7 @@ Alternatively, if you want to set build arguments when pre-building an image, th
 steps:
   - command: generate-dist.sh
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           build: app
           args:
             - MY_CUSTOM_ARG=panda
@@ -184,7 +184,7 @@ If you have multiple steps that use the same service/image (such as steps that r
 steps:
   - label: ":docker: Build"
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           build: app
           push: app
 
@@ -194,7 +194,7 @@ steps:
     command: test.sh
     parallelism: 25
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           run: app
           require-prebuild: true
 ```
@@ -213,7 +213,7 @@ steps:
     agents:
       queue: docker-builder
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           build:
             - app
             - tests
@@ -227,7 +227,7 @@ steps:
     command: test.sh
     parallelism: 25
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           run: tests
 ```
 
@@ -239,7 +239,7 @@ If you want to push your Docker images ready for deployment, you can use the `pu
 steps:
   - label: ":docker: Push"
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           push: app
 ```
 
@@ -249,7 +249,7 @@ To push multiple images, you can use a list:
 steps:
   - label: ":docker: Push"
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           push:
             - first-service
             - second-service
@@ -261,7 +261,7 @@ If you want to push to a specific location (that's not defined as the `image` in
 steps:
   - label: ":docker: Push"
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           push:
             - app:index.docker.io/myorg/myrepo/myapp
             - app:index.docker.io/myorg/myrepo/myapp:latest
@@ -275,7 +275,7 @@ A newly spawned agent won't contain any of the docker caches for the first run w
 steps:
   - label: ":docker: Build an image"
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           build: app
           push: app:index.docker.io/myorg/myrepo:my-branch
           cache-from:
@@ -286,7 +286,7 @@ steps:
 
   - label: ":docker: Push to final repository"
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           push:
             - app:myregistry:port/myrepo/myapp:latest
 ```
@@ -299,7 +299,7 @@ The values you add in the `cache-from` will be mapped to the corresponding servi
 steps:
   - label: ":docker: Build an image"
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           build: app
           push: app:index.docker.io/myorg/myrepo:my-branch
           cache-from:
@@ -310,7 +310,7 @@ steps:
 
   - label: ":docker: Push to final repository"
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           push:
             - app:myregistry:port/myrepo/myapp:latest
 ```
@@ -327,7 +327,7 @@ The `docker` driver can handle most situations but for advance features with the
 steps:
   - label: ":docker: Build an image"
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           build: app
           push: app:index.docker.io/myorg/myrepo:my-branch
           cache-from:
@@ -349,7 +349,7 @@ By default, Builder Instances specified by `name` or that are created with `crea
 steps:
   - label: ":docker: Build an image"
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           build: app
           push: app:index.docker.io/myorg/myrepo:my-branch
           cache-from:
@@ -368,7 +368,7 @@ By default, Builder Instances specified by `name` or that are created with `crea
 steps:
   - label: ":docker: Build an image"
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           build: app
           push: app:index.docker.io/myorg/myrepo:my-branch
           cache-from:
@@ -394,7 +394,7 @@ A newly spawned agent won't contain any of the docker caches for the first run w
 steps:
   - label: ":docker: Build an image and push cache"
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           build: app
           push: app:${DOCKER_REGISTRY}/${IMAGE_REPO}:cache
           cache-from:
@@ -406,12 +406,12 @@ steps:
             use: true
             create: true
             driver: docker-container
-  
+
   - wait
 
   - label: ":docker: Build an image using remote cache"
     plugins:
-      - docker-compose#v5.8.0:
+      - docker-compose#v5.9.0:
           build: app
           cache-from:
             - "app:type=registry,ref=${DOCKER_REGISTRY}/${IMAGE_REPO}:cache"

lib/shared.bash

@@ -121,9 +121,17 @@ function docker_compose_config_files() {
     return
   fi
 
+  # If COMPOSE_PATH_SEPARATOR is not set, use the default separator
+  if is_windows ; then
+    DEFAULT_SEPARATOR=";"
+  else
+    DEFAULT_SEPARATOR=":"
+  fi
+  SEPARATOR="${COMPOSE_PATH_SEPARATOR:-$DEFAULT_SEPARATOR}"
+
   # Process any (deprecated) colon delimited config paths
   for value in "${config_files[@]}" ; do
-    echo "$value" | tr ':' '\n'
+    echo "$value" | tr "${SEPARATOR}" '\n'
   done
 }