Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions .github/ISSUE_TEMPLATE/0-bug.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: "⚠️ Report an Issue"
description: "Something Not Working Right? Please let us know..."
description: "Please let us know if something is not working right..."
labels: ["bug"]
assignees:
- smashedr
Expand All @@ -10,17 +10,17 @@ body:
validations:
required: false
attributes:
label: Repo Link
description: Please provide a link to the repository or workflow you are having issues with if possible.
label: URL
description: Please provide a link to the repository or workflow in question if possible.

- type: textarea
id: description
validations:
required: true
attributes:
label: Details
description: Please describe the issue you are experiencing and how to reproduce.
placeholder: Provide as many details as you can...
label: Issue Description
description: Please describe the issue you are experiencing and how it can be reproduced.
placeholder: Provide as many details as possible...

- type: textarea
id: logs
Expand All @@ -29,9 +29,11 @@ body:
attributes:
label: Log Output
description: Paste any relevant logs or output in this box.
placeholder: This text is automatically wrapped in a code block.
render: shell

- type: markdown
attributes:
value: |
All issues/bugs that we can verify will be fixed. Thank you for taking the time to make this report!
Any issues or bugs that can be verified will be fixed!
Thank you very much for taking the time to make this report...
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
blank_issues_enabled: true
contact_links:
- name: "💡 Request a Feature"
about: Request a New Feature or Enhancement in the Discussions.
url: https://github.com/cssnr/stack-deploy-action/discussions/new?category=feature-requests
about: Request a new feature or enhancement in a discussions.
url: https://github.com/cssnr/virustotal-action/discussions/new?category=feature-requests

- name: "❔ Ask a Question"
about: Ask a General Question or start a Discussions.
url: https://github.com/cssnr/stack-deploy-action/discussions/new?category=q-a
about: Ask a general question or start a discussions.
url: https://github.com/cssnr/virustotal-action/discussions/new?category=q-a

- name: "💬 Join Discord"
about: Chat with us about Issues, Features, Questions and More.
about: Chat with us about general questions, issues or suggestions.
url: https://discord.gg/wXy6m2X8wY

- name: "📝 Submit Feedback"
about: Send General Feedback.
about: Send general feedback through the website.
url: https://cssnr.github.io/feedback
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@


## Checklist
<!-- Do NOT remove existing tasks, append any custom tasks -->
- [ ] Verify Required Checks are Passing
<!-- Do NOT remove tasks and append any custom tasks -->
- [ ] Verify the Required Checks are Passing
- [ ] Document changes in the [README.md](../blob/master/README.md) (for new features)
8 changes: 4 additions & 4 deletions .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ on:
push:
branches: [master]

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
lint:
name: "Lint"
runs-on: ubuntu-latest
timeout-minutes: 5

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

steps:
- name: "Checkout"
uses: actions/checkout@v4
Expand Down
16 changes: 8 additions & 8 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ on:
- cron: "18 18 * * 1,3,5"
push:
branches: ["**"]
#paths:
# - "dist/**"
# - "src/**"
# - ".github/workflows/test.yaml"
# - "Dockerfile"
# - "package*.json"
# - "requirements.txt"
# - "action.yaml"
paths:
- "dist/**"
- "src/**"
- ".github/workflows/test.yaml"
- "Dockerfile"
- "package*.json"
- "requirements*.txt"
- "action.yaml"

env:
PRIVATE_IMAGE: ${{ vars.PRIVATE_IMAGE || 'smashedr/alpine-private:latest' }}
Expand Down
32 changes: 17 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[![Tags](https://img.shields.io/badge/tags-v1_%7C_v1.2-blue?logo=git&logoColor=white)](https://github.com/cssnr/stack-deploy-action/tags)
[![GitHub Release Version](https://img.shields.io/github/v/release/cssnr/stack-deploy-action?logo=git&logoColor=white&label=latest)](https://github.com/cssnr/stack-deploy-action/releases/latest)
[![GitHub Tag Major](https://img.shields.io/github/v/tag/cssnr/stack-deploy-action?sort=semver&filter=!v*.*&logo=git&logoColor=white&labelColor=585858&label=%20)](https://github.com/cssnr/stack-deploy-action/tags)
[![GitHub Tag Minor](https://img.shields.io/github/v/tag/cssnr/stack-deploy-action?sort=semver&filter=!v*.*.*&logo=git&logoColor=white&labelColor=585858&label=%20)](https://github.com/cssnr/stack-deploy-action/tags)
[![GitHub Release Version](https://img.shields.io/github/v/release/cssnr/stack-deploy-action?logo=git&logoColor=white&labelColor=585858&label=%20)](https://github.com/cssnr/stack-deploy-action/releases/latest)
[![Release WF](https://img.shields.io/github/actions/workflow/status/cssnr/stack-deploy-action/release.yaml?logo=github&label=release)](https://github.com/cssnr/stack-deploy-action/actions/workflows/release.yaml)
[![Test WF](https://img.shields.io/github/actions/workflow/status/cssnr/stack-deploy-action/test.yaml?logo=github&label=test)](https://github.com/cssnr/stack-deploy-action/actions/workflows/test.yaml)
[![Lint WF](https://img.shields.io/github/actions/workflow/status/cssnr/stack-deploy-action/lint.yaml?logo=github&label=lint)](https://github.com/cssnr/stack-deploy-action/actions/workflows/lint.yaml)
Expand All @@ -25,14 +26,14 @@ You can also optionally authenticate against a private registry using a username

This action uses a remote docker context to deploy the stack from the working directory allowing you to easily prepare the workspace for deployment.

For more details see [action.yaml](action.yaml) and [src/main.sh](src/main.sh).

**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.

For more details see [action.yaml](action.yaml) and [src/main.sh](src/main.sh).

## Inputs

| input | required | default | description |
Expand All @@ -54,7 +55,8 @@ For more details see [action.yaml](action.yaml) and [src/main.sh](src/main.sh).
| registry_pass | - | - | Registry Authentication Password \* |
| summary | - | `true` | Add Job Summary \* |

For additional details on inputs, see the stack deploy [documentation](https://docs.docker.com/reference/cli/docker/stack/deploy/).
_For additional details on inputs, see the stack deploy
[documentation](https://docs.docker.com/reference/cli/docker/stack/deploy/)._

**host** - The hostname or IP address of the remote docker server to deploy too.
If your hostname is behind a proxy like Cloudflare you will need to use the IP address.
Expand Down Expand Up @@ -127,7 +129,7 @@ verify: Service tdk8v42m0rvp9hz4rbfrtszb6 converged

## Examples

💡 _Click on a heading to expand or collapse an example._
💡 _Click on an example heading to expand or collapse the example._

<details open><summary>With password, docker login and --with-registry-auth</summary>

Expand Down Expand Up @@ -328,17 +330,15 @@ https://github.com/cssnr/stack-deploy-action/network/dependents

## Tags

The following [rolling tags](https://github.com/cssnr/stack-deploy-action/tags) are maintained.

| Tag | Example | Bugs | Feat. | Description |
| -------- | -------- | :--: | :---: | -------------------------------------- |
| `vN` | `v1` | ✅ | ✅ | Points to latest `vN` release. |
| `vN.N` | `v1.0` | ✅ | ❌ | Points to latest `vN.N` release. |
| `vN.N.N` | `v1.0.0` | ❌ | ❌ | Points directly to a specific release. |
The following rolling [tags](https://github.com/cssnr/stack-deploy-action/tags) are maintained.

**Important:** Make sure to use one of the [latest tags](https://github.com/cssnr/stack-deploy-action/tags).
| Tag | Example | Target | Bugs | Feat. | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -------- | :--: | :---: | --------------------------------------------------------- |
| [![GitHub Tag Major](https://img.shields.io/github/v/tag/cssnr/stack-deploy-action?sort=semver&filter=!v*.*&style=for-the-badge&label=%20&color=limegreen)](https://github.com/cssnr/stack-deploy-action/releases/latest) | `vN` | `vN.x.x` | ✅ | ✅ | Includes new features but is always backwards compatible. |
| [![GitHub Tag Minor](https://img.shields.io/github/v/tag/cssnr/stack-deploy-action?sort=semver&filter=!v*.*.*&style=for-the-badge&label=%20&color=yellowgreen)](https://github.com/cssnr/stack-deploy-action/releases/latest) | `vN.N` | `vN.N.x` | ✅ | ❌ | Only receives bug fixes. This is the most stable tag. |
| [![GitHub Release](https://img.shields.io/github/v/release/cssnr/stack-deploy-action?style=for-the-badge&label=%20&color=orange)](https://github.com/cssnr/stack-deploy-action/releases/latest) | `vN.N.N` | `vN.N.N` | ❌ | ❌ | Not a rolling tag. **Not** recommended. |

You can view the release notes for each version on the [Releases Page](https://github.com/cssnr/stack-deploy-action/releases).
You can view the release notes for each version on the [releases](https://github.com/cssnr/stack-deploy-action/releases) page.

# Support

Expand All @@ -353,6 +353,8 @@ If you are experiencing an issue/bug or getting unexpected results you can:
- 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)

For more information, see the CSSNR [SUPPORT.md](https://github.com/cssnr/.github/blob/master/.github/SUPPORT.md#support).

# Contributing

Currently, the best way to contribute to this project is to star this project on GitHub.
Expand Down