From 70aa7f79d55c6851bbcf787fc5977ad946acc0d9 Mon Sep 17 00:00:00 2001 From: Francois Campbell Date: Mon, 23 Oct 2023 10:26:44 -0400 Subject: [PATCH] Update README.md --- README.md | 54 +++++++++++++++++++++++++++--------------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 4a7d81b3..c3e05f7e 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ The following pipeline will run `test.sh` inside a `app` service container using steps: - command: test.sh plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: run: app ``` @@ -28,7 +28,7 @@ through if you need: steps: - command: test.sh plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: run: app config: docker-compose.tests.yml env: @@ -41,7 +41,7 @@ or multiple config files: steps: - command: test.sh plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: run: app config: - docker-compose.yml @@ -56,7 +56,7 @@ env: steps: - command: test.sh plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: run: app ``` @@ -65,7 +65,7 @@ If you want to control how your command is passed to docker-compose, you can use ```yml steps: - plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: run: app command: ["custom", "command", "values"] ``` @@ -79,7 +79,7 @@ steps: - plugins: - docker-login#v2.0.1: username: xyz - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: build: app image-repository: index.docker.io/myorg/myrepo - wait @@ -87,7 +87,7 @@ steps: plugins: - docker-login#v2.0.1: username: xyz - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: run: app ``` @@ -104,7 +104,7 @@ steps: - command: generate-dist.sh artifact_paths: "dist/*" plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: run: app ``` @@ -122,7 +122,7 @@ steps: - command: generate-dist.sh artifact_paths: "dist/*" plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: run: app volumes: - "./dist:/app/dist" @@ -146,7 +146,7 @@ this plugin offers a `environment` block of its own: steps: - command: generate-dist.sh plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: run: app env: - BUILDKITE_BUILD_NUMBER @@ -164,7 +164,7 @@ Alternatively, you can have the plugin add all environment variables defined for steps: - command: use-vars.sh plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: run: app propagate-environment: true ``` @@ -199,7 +199,7 @@ Alternatively, if you want to set build arguments when pre-building an image, th steps: - command: generate-dist.sh plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: build: app image-repository: index.docker.io/myorg/myrepo args: @@ -216,7 +216,7 @@ If you have multiple steps that use the same service/image (such as steps that r steps: - label: ":docker: Build" plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: build: app image-repository: index.docker.io/myorg/myrepo @@ -226,7 +226,7 @@ steps: command: test.sh parallelism: 25 plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: run: app ``` @@ -242,7 +242,7 @@ steps: agents: queue: docker-builder plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: build: - app - tests @@ -254,7 +254,7 @@ steps: command: test.sh parallelism: 25 plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: run: tests ``` @@ -266,7 +266,7 @@ If you want to push your Docker images ready for deployment, you can use the `pu steps: - label: ":docker: Push" plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: push: app ``` @@ -276,7 +276,7 @@ To push multiple images, you can use a list: steps: - label: ":docker: Push" plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: push: - first-service - second-service @@ -288,7 +288,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#v4.14.0: + - docker-compose#v4.15.0: push: - app:index.docker.io/myorg/myrepo/myapp - app:index.docker.io/myorg/myrepo/myapp:latest @@ -302,14 +302,14 @@ 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#v4.14.0: + - docker-compose#v4.15.0: build: app image-repository: index.docker.io/myorg/myrepo cache-from: app:index.docker.io/myorg/myrepo/myapp:latest - wait - label: ":docker: Push to final repository" plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: push: - app:index.docker.io/myorg/myrepo/myapp - app:index.docker.io/myorg/myrepo/myapp:latest @@ -327,7 +327,7 @@ This plugin allows for the value of `cache-from` to be a string or a list. If it steps: - label: ":docker Build an image" plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: build: app image-repository: index.docker.io/myorg/myrepo separator-cache-from: "#" @@ -337,7 +337,7 @@ steps: - wait - label: ":docker: Push to final repository" plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: push: - app:myregistry:port/myrepo/myapp:my-branch - app:myregistry:port/myrepo/myapp:latest @@ -350,7 +350,7 @@ Adding a grouping tag to the end of a cache-from list item allows this plugin to steps: - label: ":docker: Build Intermediate Image" plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: build: myservice_intermediate # docker-compose.yml is the same as myservice but has `target: intermediate` image-name: buildkite-build-${BUILDKITE_BUILD_NUMBER} image-repository: index.docker.io/myorg/myrepo/myservice_intermediate @@ -360,7 +360,7 @@ steps: - wait - label: ":docker: Build Final Image" plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: build: myservice image-name: buildkite-build-${BUILDKITE_BUILD_NUMBER} image-repository: index.docker.io/myorg/myrepo @@ -404,7 +404,7 @@ A basic pipeline similar to the following: steps: - label: ":docker: Run & Push" plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: run: myservice push: myservice ``` @@ -419,7 +419,7 @@ A basic pipeline similar to the following: steps: - label: ":docker: Build & Push" plugins: - - docker-compose#v4.14.0: + - docker-compose#v4.15.0: build: myservice push: myservice ```