From 7cb3f082fda2c18a22183e143b2b24f8545da081 Mon Sep 17 00:00:00 2001 From: Shane <6071159+smashedr@users.noreply.github.com> Date: Wed, 3 Sep 2025 21:50:43 -0700 Subject: [PATCH 1/9] Update README.md --- README.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 8925590..1ad9fbd 100644 --- a/README.md +++ b/README.md @@ -25,22 +25,23 @@ - [Support](#Support) - [Contributing](#Contributing) -> [!TIP] -> Now works with Docker **Compose. No Swarm Required!** -> ▶️ Set `mode: compose`. See [Inputs](#Inputs) for more details... - This action deploys a docker stack from a compose file to a remote docker host using SSH Password or Key File Authentication. You can also optionally authenticate against a private registry using a username and password. This action uses a remote docker context to deploy the stack from the working directory allowing you to easily prepare the workspace for deployment. +Please submit a [Feature Request](https://github.com/cssnr/stack-deploy-action/discussions/categories/feature-requests) +for new features or [Open an Issue](https://github.com/cssnr/stack-deploy-action/issues) if you find any bugs. + +For more details see the [src/main.sh](src/main.sh) and [action.yaml](action.yaml). + **Portainer Users:** You can deploy directly to Portainer with: [cssnr/portainer-stack-deploy-action](https://github.com/cssnr/portainer-stack-deploy-action) -> [!NOTE] -> Please submit a [Feature Request](https://github.com/cssnr/stack-deploy-action/discussions/categories/feature-requests) -> for new features or [Open an Issue](https://github.com/cssnr/stack-deploy-action/issues) if you find any bugs. +> [!IMPORTANT] +> Documentation Site: https://docker-deploy.cssnr.com/ +> Please refer to the website for up-to-date documentation. -For more details see [action.yaml](action.yaml) and [src/main.sh](src/main.sh). +Note: the documentation in this README will be reduced to a minimal version with the bulk of the [documentation](https://github.com/cssnr/stack-deploy-docs) on the [website](https://docker-deploy.cssnr.com/). ## Inputs @@ -70,6 +71,8 @@ For more details see [action.yaml](action.yaml) and [src/main.sh](src/main.sh). > **²** Swarm Only, view the [Docs](https://docs.docker.com/reference/cli/docker/stack/deploy/). > \* More details below... +View the [Inputs Documentation](https://docker-deploy.cssnr.com/docs/inputs). +
📟 Click Here to see how the deployment command is generated ```shell @@ -195,6 +198,8 @@ failed to create network test_stack-deploy_default: Error response from daemon: ## Examples +View more [Examples](https://docker-deploy.cssnr.com/guides/examples). + 💡 _Click on an example heading to expand or collapse the example._
With Password, docker login and --with-registry-auth @@ -485,6 +490,8 @@ Breaking changes would result in a **Major** version bump. At a minimum you shou ## Features +View the [Features](https://docker-deploy.cssnr.com/docs/inputs). + - Deploy to a remote host using SSH or Password authentication. - Deploy using a remote context from the current working directory. - Deploy from a compose file to either a Docker Swarm or Compose host. @@ -505,7 +512,7 @@ If you are experiencing an issue/bug or getting unexpected results you can: - Report an Issue: https://github.com/cssnr/stack-deploy-action/issues - Chat with us on Discord: https://discord.gg/wXy6m2X8wY -- Provide General Feedback: [https://cssnr.github.io/feedback/](https://cssnr.github.io/feedback/?app=Stack%20Deploy) +- Provide General Feedback: [https://cssnr.github.io/feedback/](https://cssnr.github.io/feedback/?app=Stack%20Deploy%20Action) For more information, see the CSSNR [SUPPORT.md](https://github.com/cssnr/.github/blob/master/.github/SUPPORT.md#support). @@ -513,6 +520,8 @@ For more information, see the CSSNR [SUPPORT.md](https://github.com/cssnr/.githu If you would like to submit a PR, please review the [CONTRIBUTING.md](CONTRIBUTING.md). +To contribute to the [documentation](https://docker-deploy.cssnr.com/) go here: https://github.com/cssnr/stack-deploy-docs + Please consider making a donation to support the development of this project and [additional](https://cssnr.com/) open source projects. From 286c6388ea43d982f0400be7d1f474e2b237120a Mon Sep 17 00:00:00 2001 From: Shane <6071159+smashedr@users.noreply.github.com> Date: Wed, 3 Sep 2025 22:08:08 -0700 Subject: [PATCH 2/9] Update README.md --- README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 1ad9fbd..cc9af8e 100644 --- a/README.md +++ b/README.md @@ -25,23 +25,19 @@ - [Support](#Support) - [Contributing](#Contributing) -This action deploys a docker stack from a compose file to a remote docker host using SSH Password or Key File Authentication. -You can also optionally authenticate against a private registry using a username and password. +Easily Deploy a Docker Swarm or Compose stack from a compose file to a remote Docker host over SSH with keyfile or password authentication. -This action uses a remote docker context to deploy the stack from the working directory allowing you to easily prepare the workspace for deployment. +Deploy directly from the actions working directory without copying any files using a remote Docker context. +This allows you to easily prepare your environment for deployment. -Please submit a [Feature Request](https://github.com/cssnr/stack-deploy-action/discussions/categories/feature-requests) -for new features or [Open an Issue](https://github.com/cssnr/stack-deploy-action/issues) if you find any bugs. +Supports authenticating against a private registry, deploying multiple stack files, setting custom arguments, and much more... -For more details see the [src/main.sh](src/main.sh) and [action.yaml](action.yaml). +View the [Getting Started Guide](https://docker-deploy.cssnr.com/guides/get-started) to get up and running. -**Portainer Users:** You can deploy directly to Portainer with: [cssnr/portainer-stack-deploy-action](https://github.com/cssnr/portainer-stack-deploy-action) - -> [!IMPORTANT] -> Documentation Site: https://docker-deploy.cssnr.com/ -> Please refer to the website for up-to-date documentation. +> [!TIP] +> View the [Getting Started Guide](https://docker-deploy.cssnr.com/guides/get-started) to get up and running. -Note: the documentation in this README will be reduced to a minimal version with the bulk of the [documentation](https://github.com/cssnr/stack-deploy-docs) on the [website](https://docker-deploy.cssnr.com/). +**Portainer Users:** You can deploy directly to Portainer with: [cssnr/portainer-stack-deploy-action](https://github.com/cssnr/portainer-stack-deploy-action) ## Inputs From a4dbd986aa5a1b4b2ab17a1aa27f458d115cb7a2 Mon Sep 17 00:00:00 2001 From: Shane <6071159+smashedr@users.noreply.github.com> Date: Wed, 3 Sep 2025 22:12:55 -0700 Subject: [PATCH 3/9] Update README.md --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cc9af8e..5b7ee65 100644 --- a/README.md +++ b/README.md @@ -28,16 +28,14 @@ Easily Deploy a Docker Swarm or Compose stack from a compose file to a remote Docker host over SSH with keyfile or password authentication. Deploy directly from the actions working directory without copying any files using a remote Docker context. -This allows you to easily prepare your environment for deployment. +This allows you to easily prepare your environment for deployment using normal steps. -Supports authenticating against a private registry, deploying multiple stack files, setting custom arguments, and much more... - -View the [Getting Started Guide](https://docker-deploy.cssnr.com/guides/get-started) to get up and running. +Supports authenticating against a private registry, deploying multiple stack files, setting custom arguments, and [much more](https://docker-deploy.cssnr.com/guides/features)... > [!TIP] > View the [Getting Started Guide](https://docker-deploy.cssnr.com/guides/get-started) to get up and running. -**Portainer Users:** You can deploy directly to Portainer with: [cssnr/portainer-stack-deploy-action](https://github.com/cssnr/portainer-stack-deploy-action) +_Portainer Users: You can deploy directly to Portainer with: [cssnr/portainer-stack-deploy-action](https://github.com/cssnr/portainer-stack-deploy-action)_ ## Inputs From cfd312a2306b2cba06274ca95ce69d82ec8ed1c8 Mon Sep 17 00:00:00 2001 From: Shane <6071159+smashedr@users.noreply.github.com> Date: Wed, 3 Sep 2025 22:21:04 -0700 Subject: [PATCH 4/9] Update README.md --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5b7ee65..33d5048 100644 --- a/README.md +++ b/README.md @@ -25,15 +25,16 @@ - [Support](#Support) - [Contributing](#Contributing) +> [!TIP] +> ▶️ View the [Getting Started Guide](https://docker-deploy.cssnr.com/guides/get-started) on the website. + Easily Deploy a Docker Swarm or Compose stack from a compose file to a remote Docker host over SSH with keyfile or password authentication. Deploy directly from the actions working directory without copying any files using a remote Docker context. This allows you to easily prepare your environment for deployment using normal steps. -Supports authenticating against a private registry, deploying multiple stack files, setting custom arguments, and [much more](https://docker-deploy.cssnr.com/guides/features)... - -> [!TIP] -> View the [Getting Started Guide](https://docker-deploy.cssnr.com/guides/get-started) to get up and running. +Supports authenticating against a private registry, deploying multiple stack files, setting custom arguments, and much more... +You can check out all the [features](https://docker-deploy.cssnr.com/guides/features). _Portainer Users: You can deploy directly to Portainer with: [cssnr/portainer-stack-deploy-action](https://github.com/cssnr/portainer-stack-deploy-action)_ From d2a5c41a82fe923d6ad26a789d000272f592c90f Mon Sep 17 00:00:00 2001 From: Shane <6071159+smashedr@users.noreply.github.com> Date: Wed, 3 Sep 2025 22:24:35 -0700 Subject: [PATCH 5/9] Update README.md --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 33d5048..35500d9 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Easily Deploy a Docker Swarm or Compose stack from a compose file to a remote Do Deploy directly from the actions working directory without copying any files using a remote Docker context. This allows you to easily prepare your environment for deployment using normal steps. -Supports authenticating against a private registry, deploying multiple stack files, setting custom arguments, and much more... +Supports authenticating against a private registry, deploying multiple stack files, setting custom arguments, and much more. You can check out all the [features](https://docker-deploy.cssnr.com/guides/features). _Portainer Users: You can deploy directly to Portainer with: [cssnr/portainer-stack-deploy-action](https://github.com/cssnr/portainer-stack-deploy-action)_ @@ -487,14 +487,15 @@ Breaking changes would result in a **Major** version bump. At a minimum you shou View the [Features](https://docker-deploy.cssnr.com/docs/inputs). -- Deploy to a remote host using SSH or Password authentication. -- Deploy using a remote context from the current working directory. -- Deploy from a compose file to either a Docker Swarm or Compose host. -- Displays output in logs, captures it in the Summary, and checks the status. -- Allows logging into a private registry and deploying with registry auth. -- Allows specifying all arguments for both Swarm and Compose deployments. +- Deploy to Docker Swarm or Compose. +- Deploy over SSH using keyfile or password. +- Deploy from the current working directory. +- Deploy from a private registry with credentials. +- Job Summary with deployment output, including errors. +- Supports multiple compose file and stack deployments. +- Allows setting custom arguments for the deployment command. -Don't see your feature here? Request it below in the [Support](#Support) section. +Don't see your feature here? Please submit a [Feature Request](https://github.com/cssnr/stack-deploy-action/discussions/categories/feature-requests). # Support From b944c802bea979f9f219b5463f363cf023b781b8 Mon Sep 17 00:00:00 2001 From: Shane <6071159+smashedr@users.noreply.github.com> Date: Wed, 3 Sep 2025 22:29:00 -0700 Subject: [PATCH 6/9] Update README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 35500d9..5707da3 100644 --- a/README.md +++ b/README.md @@ -34,12 +34,14 @@ Deploy directly from the actions working directory without copying any files usi This allows you to easily prepare your environment for deployment using normal steps. Supports authenticating against a private registry, deploying multiple stack files, setting custom arguments, and much more. -You can check out all the [features](https://docker-deploy.cssnr.com/guides/features). +You can check out all the [features](https://docker-deploy.cssnr.com/guides/features) on the website. _Portainer Users: You can deploy directly to Portainer with: [cssnr/portainer-stack-deploy-action](https://github.com/cssnr/portainer-stack-deploy-action)_ ## Inputs +View the full [Inputs Documentation](https://docker-deploy.cssnr.com/docs/inputs) on the website. + | Input Name | Required | Default Value | Short Description of Input | | :------------------- | :----------: | :---------------------------------- | :---------------------------------------- | | `name` | **Yes** | - | Docker Stack/Project Name \* | @@ -66,8 +68,6 @@ _Portainer Users: You can deploy directly to Portainer with: [cssnr/portainer-st > **²** Swarm Only, view the [Docs](https://docs.docker.com/reference/cli/docker/stack/deploy/). > \* More details below... -View the [Inputs Documentation](https://docker-deploy.cssnr.com/docs/inputs). -
📟 Click Here to see how the deployment command is generated ```shell @@ -193,7 +193,7 @@ failed to create network test_stack-deploy_default: Error response from daemon: ## Examples -View more [Examples](https://docker-deploy.cssnr.com/guides/examples). +View more [Examples](https://docker-deploy.cssnr.com/guides/examples) on the website. 💡 _Click on an example heading to expand or collapse the example._ @@ -485,8 +485,6 @@ Breaking changes would result in a **Major** version bump. At a minimum you shou ## Features -View the [Features](https://docker-deploy.cssnr.com/docs/inputs). - - Deploy to Docker Swarm or Compose. - Deploy over SSH using keyfile or password. - Deploy from the current working directory. @@ -495,6 +493,8 @@ View the [Features](https://docker-deploy.cssnr.com/docs/inputs). - Supports multiple compose file and stack deployments. - Allows setting custom arguments for the deployment command. +View all the [Features](https://docker-deploy.cssnr.com/docs/inputs) on the website. + Don't see your feature here? Please submit a [Feature Request](https://github.com/cssnr/stack-deploy-action/discussions/categories/feature-requests). # Support @@ -516,7 +516,7 @@ For more information, see the CSSNR [SUPPORT.md](https://github.com/cssnr/.githu If you would like to submit a PR, please review the [CONTRIBUTING.md](CONTRIBUTING.md). -To contribute to the [documentation](https://docker-deploy.cssnr.com/) go here: https://github.com/cssnr/stack-deploy-docs +To contribute to the [documentation site](https://docker-deploy.cssnr.com/) go here: https://github.com/cssnr/stack-deploy-docs Please consider making a donation to support the development of this project and [additional](https://cssnr.com/) open source projects. From 675cb2f685376893b6898f938574543c1df2d536 Mon Sep 17 00:00:00 2001 From: Shane <6071159+smashedr@users.noreply.github.com> Date: Wed, 3 Sep 2025 22:33:36 -0700 Subject: [PATCH 7/9] Update README.md --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5707da3..f763fd3 100644 --- a/README.md +++ b/README.md @@ -28,13 +28,13 @@ > [!TIP] > ▶️ View the [Getting Started Guide](https://docker-deploy.cssnr.com/guides/get-started) on the website. -Easily Deploy a Docker Swarm or Compose stack from a compose file to a remote Docker host over SSH with keyfile or password authentication. +Easily Deploy a Docker Swarm or Compose Stack, from a compose file, to a remote Docker host over SSH, with keyfile or password authentication. Deploy directly from the actions working directory without copying any files using a remote Docker context. This allows you to easily prepare your environment for deployment using normal steps. Supports authenticating against a private registry, deploying multiple stack files, setting custom arguments, and much more. -You can check out all the [features](https://docker-deploy.cssnr.com/guides/features) on the website. +You can view all the [features](https://docker-deploy.cssnr.com/guides/features) on the website. _Portainer Users: You can deploy directly to Portainer with: [cssnr/portainer-stack-deploy-action](https://github.com/cssnr/portainer-stack-deploy-action)_ @@ -82,6 +82,8 @@ fi Compose Note: `"${STACK_FILES[@]}"` is an array of `-f docker-compose.yaml` for every `file` in the argument. +--- +
**name:** Stack name for Swarm and project name for Compose. @@ -485,6 +487,8 @@ Breaking changes would result in a **Major** version bump. At a minimum you shou ## Features +View all the [Features](https://docker-deploy.cssnr.com/docs/inputs) on the website. + - Deploy to Docker Swarm or Compose. - Deploy over SSH using keyfile or password. - Deploy from the current working directory. @@ -493,9 +497,7 @@ Breaking changes would result in a **Major** version bump. At a minimum you shou - Supports multiple compose file and stack deployments. - Allows setting custom arguments for the deployment command. -View all the [Features](https://docker-deploy.cssnr.com/docs/inputs) on the website. - -Don't see your feature here? Please submit a [Feature Request](https://github.com/cssnr/stack-deploy-action/discussions/categories/feature-requests). +Don't see your feature here? Please help by submitting a [Feature Request](https://github.com/cssnr/stack-deploy-action/discussions/categories/feature-requests). # Support From 63fccb7315ed6317631a35461879756e059bac5d Mon Sep 17 00:00:00 2001 From: Shane <6071159+smashedr@users.noreply.github.com> Date: Wed, 3 Sep 2025 22:38:53 -0700 Subject: [PATCH 8/9] Update README.md --- README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f763fd3..a165a18 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,20 @@ This allows you to easily prepare your environment for deployment using normal s Supports authenticating against a private registry, deploying multiple stack files, setting custom arguments, and much more. You can view all the [features](https://docker-deploy.cssnr.com/guides/features) on the website. +```yaml +- name: 'Stack Deploy' + uses: cssnr/stack-deploy-action@v1 + with: + name: 'stack-name' # set to your stack name + file: 'docker-compose.yaml' # set to your compose file + host: ${{ secrets.DOCKER_HOST }} + user: ${{ secrets.DOCKER_USER }} + port: 22 # 22 is default, you can remove or change this + pass: ${{ secrets.DOCKER_PASS }} # not needed with ssh_key + ssh_key: ${{ secrets.DOCKER_SSH_KEY }} # not needed with pass + mode: swarm # if not using swarm set to: compose +``` + _Portainer Users: You can deploy directly to Portainer with: [cssnr/portainer-stack-deploy-action](https://github.com/cssnr/portainer-stack-deploy-action)_ ## Inputs @@ -184,13 +198,14 @@ failed to create network test_stack-deploy_default: Error response from daemon: - name: 'Stack Deploy' uses: cssnr/stack-deploy-action@v1 with: - name: 'stack-name' - file: 'docker-compose-swarm.yaml' + name: 'stack-name' # set to your stack name + file: 'docker-compose.yaml' # set to your compose file host: ${{ secrets.DOCKER_HOST }} - port: ${{ secrets.DOCKER_PORT }} user: ${{ secrets.DOCKER_USER }} + port: 22 # 22 is default, you can remove or change this pass: ${{ secrets.DOCKER_PASS }} # not needed with ssh_key ssh_key: ${{ secrets.DOCKER_SSH_KEY }} # not needed with pass + mode: swarm # if not using swarm set to: compose ``` ## Examples From 7d9d16c22e837d8c85d6f39704bdf27c03fbb78d Mon Sep 17 00:00:00 2001 From: Shane <6071159+smashedr@users.noreply.github.com> Date: Wed, 3 Sep 2025 22:42:08 -0700 Subject: [PATCH 9/9] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index a165a18..e79bad6 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,8 @@ You can view all the [features](https://docker-deploy.cssnr.com/guides/features) mode: swarm # if not using swarm set to: compose ``` +For usage and setup guides, visit the website: https://docker-deploy.cssnr.com/ + _Portainer Users: You can deploy directly to Portainer with: [cssnr/portainer-stack-deploy-action](https://github.com/cssnr/portainer-stack-deploy-action)_ ## Inputs