docker-compose -> docker compose

flemay · Sep 1, 2024 · ee14ba0 · ee14ba0
1 parent 32bc7ed
commit ee14ba0
Show file tree

Hide file tree

Showing 10 changed files with 32 additions and 31 deletions.
diff --git a/Makefile b/Makefile
@@ -1,7 +1,7 @@
-COMPOSE_PULL = docker-compose pull
-COMPOSE_RUN_NODE = docker-compose run --rm node
-COMPOSE_UP_NODE = docker-compose up -d node
-COMPOSE_UP_NODE_DEV = docker-compose up node_dev
+COMPOSE_PULL = docker compose pull
+COMPOSE_RUN_NODE = docker compose run --rm node
+COMPOSE_UP_NODE = docker compose up -d node
+COMPOSE_UP_NODE_DEV = docker compose up node_dev
 ENVFILE ?= env.template
 SERVE_BASE_URL ?= http://node:5173
 
@@ -73,7 +73,7 @@ _deploy:
 	--commit-message="Deploy!"
 
 pruneDocker:
-	docker-compose down --remove-orphans --volumes
+	docker compose down --remove-orphans --volumes
 
 prune:
 	$(COMPOSE_RUN_NODE) bash -c "rm -fr docs/.vitepress/dist docs/.vitepress/.cache"

diff --git a/README.md b/README.md
@@ -93,7 +93,7 @@ Let's print out `Hello, World!` in the terminal using the 3 Musketeers. The comm
 Create the following 2 files:
 
 ```yaml
-# docker-compose.yml
+# compose.yml
 services:
   alpine:
     image: alpine

diff --git a/docker-compose.yml → compose.yml b/docker-compose.yml → compose.yml
diff --git a/diagrams/Makefile b/diagrams/Makefile
@@ -1,5 +1,5 @@
 COMPOSE_PULL = docker compose pull
-COMPOSE_RUN_MERMAID_SH = docker-compose run --rm --entrypoint sh mermaid
+COMPOSE_RUN_MERMAID_SH = docker compose run --rm --entrypoint sh mermaid
 
 all: deps mermaid prune
 
@@ -13,4 +13,4 @@ shell:
 	$(COMPOSE_RUN_MERMAID_SH)
 
 prune:
-	docker-compose down --remove-orphans --volumes
+	docker compose down --remove-orphans --volumes
diff --git a/docs/guide/docker.md b/docs/guide/docker.md
@@ -86,7 +86,7 @@ Mounting volumes with Docker on Mac or Windows can be slow. For instance, develo
 On Mac, using the `native_osx` strategy can also help. The Docker Compose file would look like the following:
 
 ```yaml
-# docker-compose.yml
+# compose.yml
  yourservice:
     image: animage
     volumes:

diff --git a/docs/guide/environment-variables.md b/docs/guide/environment-variables.md
@@ -41,10 +41,10 @@ ENV_B=
 ENV_C=env_c
 ```
 
-And the file `docker-compose.yml`:
+And the file `compose.yml`:
 
 ```yaml
-# docker-compose.yml
+# compose.yml
 services:
   alpine:
     image: alpine
@@ -118,7 +118,7 @@ ENV_VAR_B=b
     - env.template
     - env.example
     - makefile
-    - docker-compose.yml
+    - compose.yml
     - application source code
     - pipeline-as-code file
 - Error prone
@@ -160,10 +160,10 @@ And the file `env.example`:
 ENV_MY_VAR=MY_VALUE
 ```
 
-And the file `docker-compose.yml`:
+And the file `compose.yml`:
 
 ```yaml
-# docker-compose.yml
+# compose.yml
 version: "3.8"
 services:
   alpine:
@@ -177,7 +177,7 @@ services:
 ```
 
 ::: info
-The `docker-compose.yml` above has the [variable substitution][linkDockerComposeVarialeSubstitution] `env_file: ${ENVFILE:-.env}`, which allows the use of a different file that `.env` by defining the environment variable `ENVFILE`. This was required for using Compose otherwise Compose would simply fail. Examples in this section will use `.env` except when generating the file.
+The `compose.yml` above has the [variable substitution][linkDockerComposeVarialeSubstitution] `env_file: ${ENVFILE:-.env}`, which allows the use of a different file that `.env` by defining the environment variable `ENVFILE`. This was required for using Compose otherwise Compose would simply fail. Examples in this section will use `.env` except when generating the file.
 :::
 
 #### Explicit
@@ -190,7 +190,7 @@ Explicit is the method I prefer the most.
 
 ```make
 # Makefile
-COMPOSE_RUN_ALPINE = docker-compose run alpine
+COMPOSE_RUN_ALPINE = docker compose run alpine
 ENVFILE ?= env.template
 
 envfile:
@@ -225,7 +225,7 @@ Targets requiring `.env` file will get it created if it does not exist. The `.en
 
 ```make
 # Makefile
-COMPOSE_RUN_ALPINE = docker-compose run alpine
+COMPOSE_RUN_ALPINE = docker compose run alpine
 ENVFILE ?= env.template
 
 .env:
@@ -262,7 +262,7 @@ Targets requiring `.env` file will get it created if it does not exist. The `.en
 
 ```makefile
 # Makefile
-COMPOSE_RUN_ALPINE = docker-compose run alpine
+COMPOSE_RUN_ALPINE = docker compose run alpine
 ifdef ENVFILE
 	ENVFILE_TARGET=envfile
 else
@@ -299,7 +299,7 @@ make target ENVFILE=env.example
 
 ### With Make and Docker
 
-Everything covered in section [With Make and Compose][linkSectionWithMakeAndCompose] can be applied here except Docker won't use `docker-compose.yml`. Here's an example with the explicit method:
+Everything covered in section [With Make and Compose][linkSectionWithMakeAndCompose] can be applied here except Docker won't use `compose.yml`. Here's an example with the explicit method:
 
 ```makefile
 # Makefile
@@ -446,7 +446,7 @@ ENV_MESSAGE="Hello, World!"
 ```
 
 ```yml
-# docker-compose.yml
+# compose.yml
 version: '3.8'
 services:
   alpine:
@@ -461,7 +461,7 @@ services:
 
 ```makefile
 # Makefile
-COMPOSE_RUN_ALPINE = docker-compose run alpine
+COMPOSE_RUN_ALPINE = docker compose run alpine
 ENVFILE ?= env.template
 
 envfile:

diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
@@ -17,7 +17,7 @@ Let's print out `Hello, World!` in the terminal using the 3 Musketeers. The comm
 Create the following 2 files:
 
 ```yaml
-# docker-compose.yml
+# compose.yml
 services:
   alpine:
     image: alpine

diff --git a/docs/guide/patterns.md b/docs/guide/patterns.md
@@ -39,7 +39,7 @@ There are [ways][linkDocker] to add Make to your Docker image if it does not hav
 :::
 
 ```yaml
-# docker-compose.yml
+# compose.yml
 version: '3'
 services:
   alpine:
@@ -67,7 +67,7 @@ make echo
 Make calls Compose which executes a shell/bash command inside a Docker container.
 
 ```yaml
-# docker-compose.yml
+# compose.yml
 version: '3'
 services:
   alpine:
@@ -122,7 +122,7 @@ chmod +x make.sh
 ```
 
 ```yaml
-# docker-compose.yml
+# compose.yml
 version: '3.8'
 services:
   alpine:
@@ -158,7 +158,7 @@ func main() {
 ```
 
 ```yaml
-# docker-compose.yml
+# compose.yml
 version: '3'
 services:
   golang:
@@ -194,7 +194,7 @@ There are many languages and tools out there to make task implementation easy su
 ```
 
 ```yaml
-# docker-compose.yml
+# compose.yml
 version: '3'
 services:
   node:
@@ -207,7 +207,7 @@ services:
 ```makefile
 # Makefile
 echo:
-	docker-compose run --rm node npm run echo
+	docker compose run --rm node npm run echo
 ```
 
 ```bash

diff --git a/docs/guide/project-dependencies.md b/docs/guide/project-dependencies.md
@@ -13,7 +13,7 @@ This approach relies on official Docker images to manage dependencies. For insta
 Example from The [3 Musketeers repository](https://github.com/flemay/3musketeers):
 
 ```yaml
-# docker-compose.yml
+# compose.yml
 services:
   node:
     image: node
@@ -25,7 +25,7 @@ services:
 Official images may not always solve project's dependency requirements and if other projects share the same requirements, then custom Docker images may be a good fit. The images are built by the organization, and deployed to a Docker registry. From a project perspective, it is the same as using official Docker images except, this time, the organization is responsible of maintaining them.
 
 ```yaml
-# docker-compose.yml
+# compose.yml
 services:
   theservice:
     image: theorganisation/theimage
@@ -50,7 +50,7 @@ RUN npm install -g \
 ```
 
 ```yaml
-# docker-compose.yml
+# compose.yml
 services:
   mycontainer:
     build: .

diff --git a/package.json b/package.json
@@ -15,6 +15,7 @@
     "docker",
     "make",
     "makefile",
+    "compose",
     "docker-compose",
     "cicd",
     "methodology"