Merge branch 'main' into 'renovate/configure'

# Conflicts:
#   README.md
#   bumpversion.sh
#   kicker.json
#   templates/gitlab-ci-docker-compose.yml

CHANGELOG.md

+# 1.0.0 (2024-04-09)
+
+
+### Features
+
+* initial version ([df08495](https://gitlab.com/to-be-continuous/docker-compose/commit/df0849597058a7594093f7ce2e2d4d302891205b))

bumpversion.sh

@@ -33,7 +33,7 @@ if [[ "$curVer" ]]; then
   # replace in template and variants
   for tmpl in templates/*.yml
   do
-    sed -e "s/command: *\[\"--service\", \"\(.*\)\", \"$curVer\"\]/command: [\"--service\", \"\1\", \"$nextVer\"]/" "$tmpl" > "$tmpl.next"
+    sed -e "s/command: *\[ *\"--service\", *\"\(.*\)\", *\"$curVer\" *\]/command: [\"--service\", \"\1\", \"$nextVer\"]/" "$tmpl" > "$tmpl.next"
     mv -f "$tmpl.next" "$tmpl"
   done
 else

kicker.json

@@ -10,17 +10,13 @@
     {
       "name": "DCMP_IMAGE",
       "description": "The Docker image used to run Docker Compose CLI commands - **set the version required by your Docker Compose cluster**",
-      "default": "registry.hub.docker.com/docker-compose:latest"
+      "default": "registry.hub.docker.com/library/docker:latest"
     },
     {
-      "name": "DCMP_API_URL",
-      "type": "url",
-      "description": "Default Docker Compose API url"
-    },
-    {
-      "name": "DCMP_API_TOKEN",
-      "description": "Default Docker Compose API token",
-      "secret": true
+      "name": "DCMP_CMD",
+      "description": "The docker compose command (empty means _auto_)",
+      "values": ["", "docker compose", "docker-compose"],
+      "advanced": true
     },
     {
       "name": "DCMP_BASE_APP_NAME",
@@ -35,22 +31,60 @@
     },
     {
       "name": "DCMP_SCRIPTS_DIR",
-      "description": "Directory where deploy & cleanup scripts are located",
+      "description": "Directory where Compose files, dotenv files and hook scripts are located",
       "default": ".",
       "advanced": true
+    },
+    {
+      "name": "DCMP_UP_OPTS",
+      "description": "[`compose up` options](https://docs.docker.com/reference/cli/docker/compose/up/#options)",
+      "default": "--no-build --remove-orphans --wait --wait-timeout 180"
+    },
+    {
+      "name": "DCMP_DOWN_OPTS",
+      "description": "[`compose down` options](https://docs.docker.com/reference/cli/docker/compose/down/#options)",
+      "default": "--volumes --remove-orphans --rmi all"
+    },    
+    {
+      "name": "DCMP_SSH_PRIVATE_KEY",
+      "description": "Default SSH key to use when connecting to Docker hosts over SSH (can be overridden per env)",
+      "secret": true
+    },
+    {
+      "name": "DCMP_SSH_KNOWN_HOSTS",
+      "description": "SSH `known_hosts` (file or text variable)"
     }
 ],
   "features": [
+    {
+      "id": "config",
+      "name": "Compose Config",
+      "description": "Runs [`compose config`](https://docs.docker.com/reference/cli/docker/compose/config/) to detect errors in your Compose file(s)",
+      "disable_with": "DCMP_CONFIG_DISABLED",
+      "variables": [
+        {
+          "name": "DCMP_CONFIG_OPTS",
+          "description": "[`compose config` options](https://docs.docker.com/reference/cli/docker/compose/config/#options)",
+          "default": "--quiet",
+          "advanced": true
+        }
+      ]
+    },
     {
       "id": "review",
       "name": "Review",
       "description": "Dynamic review environments for your topic branches (see GitLab [Review Apps](https://docs.gitlab.com/ee/ci/review_apps/))",
       "variables": [
         {
-          "name": "DCMP_REVIEW_PROJECT",
-          "description": "Project ID for `review` env",
+          "name": "DCMP_REVIEW_DOCKER_HOST",
+          "description": "Docker Host for `review` env (ex: `ssh://docker@docker-host-for-review:2375`)",
           "mandatory": true
         },
+        {
+          "name": "DCMP_REVIEW_SSH_PRIVATE_KEY",
+          "description": "`review` env specific SSH key to use when connecting to Docker Host over SSH",
+          "secret": true
+        },
         {
           "name": "DCMP_REVIEW_APP_NAME",
           "description": "The application name for `review` env (only define to override default)",
@@ -66,17 +100,6 @@
           "type": "url",
           "description": "The `review` environments url _(only define for static environment URLs declaration and if different from default)_",
           "advanced": true
-        },
-        {
-          "name": "DCMP_REVIEW_API_URL",
-          "type": "url",
-          "description": "API url for `review` env _(only define to override default)_",
-          "advanced": true
-        },
-        {
-          "name": "DCMP_REVIEW_API_TOKEN",
-          "description": "API token for `review` env (only define to override default)",
-          "secret": true
         }
       ]
     },
@@ -86,10 +109,15 @@
       "description": "A continuous-integration environment associated to your integration branch (`develop` by default)",
       "variables": [
         {
-          "name": "DCMP_INTEG_PROJECT",
-          "description": "Project ID for `integration` env",
+          "name": "DCMP_INTEG_DOCKER_HOST",
+          "description": "Docker Host for `integration` env (ex: `ssh://docker@docker-host-for-integ:2375`)",
           "mandatory": true
         },
+        {
+          "name": "DCMP_INTEG_SSH_PRIVATE_KEY",
+          "description": "`integration` env specific SSH key to use when connecting to Docker Host over SSH",
+          "secret": true
+        },
         {
           "name": "DCMP_INTEG_APP_NAME",
           "description": "The application name for `integration` env (only define to override default)",
@@ -100,17 +128,6 @@
           "type": "url",
           "description": "The `integration` environment url _(only define for static environment URLs declaration and if different from default)_",
           "advanced": true
-        },
-        {
-          "name": "DCMP_INTEG_API_URL",
-          "type": "url",
-          "description": "API url for `integration` env _(only define to override default)_",
-          "advanced": true
-        },
-        {
-          "name": "DCMP_INTEG_API_TOKEN",
-          "description": "API token for `integration` env (only define to override default)",
-          "secret": true
         }
       ]
     },
@@ -120,10 +137,15 @@
       "description": "An iso-prod environment meant for testing and validation purpose on your production branch (`main` or `master` by default)",
       "variables": [
         {
-          "name": "DCMP_STAGING_PROJECT",
-          "description": "Project ID for `staging` env",
+          "name": "DCMP_STAGING_DOCKER_HOST",
+          "description": "Docker Host for `staging` env (ex: `ssh://docker@docker-host-for-staging:2375`)",
           "mandatory": true
         },
+        {
+          "name": "DCMP_STAGING_SSH_PRIVATE_KEY",
+          "description": "`staging` env specific SSH key to use when connecting to Docker Host over SSH",
+          "secret": true
+        },
         {
           "name": "DCMP_STAGING_APP_NAME",
           "description": "The application name for `staging` env (only define to override default)",
@@ -134,17 +156,6 @@
           "type": "url",
           "description": "The `staging` environment url _(only define for static environment URLs declaration and if different from default)_",
           "advanced": true
-        },
-        {
-          "name": "DCMP_STAGING_API_URL",
-          "type": "url",
-          "description": "API url for `staging` env _(only define to override default)_",
-          "advanced": true
-        },
-        {
-          "name": "DCMP_STAGING_API_TOKEN",
-          "description": "API token for `staging` env (only define to override default)",
-          "secret": true
         }
       ]
     },
@@ -154,10 +165,15 @@
       "description": "The production environment",
       "variables": [
         {
-          "name": "DCMP_PROD_PROJECT",
-          "description": "Project ID for `production` env",
+          "name": "DCMP_PROD_DOCKER_HOST",
+          "description": "Docker Host for `production` env (ex: `ssh://docker@docker-host-for-prod:2375`)",
           "mandatory": true
         },
+        {
+          "name": "DCMP_PROD_SSH_PRIVATE_KEY",
+          "description": "`production` env specific SSH key to use when connecting to Docker Host over SSH",
+          "secret": true
+        },
         {
           "name": "DCMP_PROD_APP_NAME",
           "description": "The application name for `production` env (only define to override default)",
@@ -175,17 +191,6 @@
           "type": "enum",
           "values": ["manual", "auto"],
           "default": "manual"
-        },
-        {
-          "name": "DCMP_PROD_API_URL",
-          "type": "url",
-          "description": "API url for `production` env _(only define to override default)_",
-          "advanced": true
-        },
-        {
-          "name": "DCMP_PROD_API_TOKEN",
-          "description": "API token for `production` env (only define to override default)",
-          "secret": true
         }
       ]
     }