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
2 changes: 1 addition & 1 deletion .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export default defineConfig({
config(md) {
md.use(groupIconMdPlugin)
},
// toc: { level: [2] },
toc: { level: [2] },
},

title: settings.title,
Expand Down
94 changes: 94 additions & 0 deletions .vitepress/theme/components/StackTable.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
<script setup>
const props = defineProps({
repos: { type: Array, required: true },
style: { type: String, default: 'flat' },
})

function getLink(type, repo) {
const links = {
stars: `https://img.shields.io/github/stars/${repo}?style=${props.style}&label=%20&color=forestgreen`,
forks: `https://img.shields.io/github/forks/${repo}?style=${props.style}&label=%20&color=blue`,
last: `https://img.shields.io/github/last-commit/${repo}?display_timestamp=committer&style=${props.style}&label=%20`,
language: `https://img.shields.io/github/languages/top/${repo}?style=${props.style}`,
}
return links[type]
}
</script>

<template>
<table class="stack-table">
<thead>
<tr>
<th>Repositories - {{ props.repos.length }}</th>
<th class="center" style="padding: 0">⭐🍴</th>
<th class="center">Updated</th>
<th>Language</th>
</tr>
</thead>
<tbody>
<tr v-for="repo in props.repos" :key="repo">
<td class="repository">
<a :href="`https://github.com/${repo}`" :title="repo" target="_blank" rel="noopener">{{ repo }}</a>
</td>
<td class="center">
<a :href="`https://github.com/${repo}/stargazers`" target="_blank" rel="noopener">
<img alt="S" :src="getLink('stars', repo)" style="margin-right: 4px"
/></a>
<a :href="`https://github.com/${repo}/forks`" target="_blank" rel="noopener">
<img alt="F" :src="getLink('forks', repo)"
/></a>
</td>
<td class="center">
<a :href="`https://github.com/${repo}/pulse`" target="_blank" rel="noopener">
<img alt="Updated" :src="getLink('last', repo)"
/></a>
</td>
<td>
<a :href="`https://github.com/${repo}/network/dependents`" target="_blank" rel="noopener">
<img alt="Language" :src="getLink('language', repo)" />
</a>
</td>
</tr>
</tbody>
</table>
</template>

<style scoped>
.stack-table td.repository {
text-wrap: nowrap;
overflow: hidden;
text-overflow: ellipsis;
max-width: 160px;
}
@media (min-width: 540px) {
.stack-table td.repository {
max-width: 200px;
}
}
@media (min-width: 721px) {
.stack-table td.repository {
max-width: 260px;
}
}
@media (min-width: 1066px) {
.stack-table td.repository {
max-width: 310px;
}
}

.stack-table td {
padding: 4px;
}
.stack-table img {
height: auto;
width: auto;
max-width: none;
max-height: none;
margin-right: 0;
vertical-align: middle;
}
.stack-table .center {
text-align: center;
text-wrap: nowrap;
}
</style>
4 changes: 4 additions & 0 deletions .vitepress/theme/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ summary {
cursor: pointer;
}

table th {
text-wrap: nowrap;
}

.vp-doc img {
display: inline-block;
margin-right: 8px;
Expand Down
2 changes: 2 additions & 0 deletions .vitepress/theme/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import 'virtual:group-icons.css'

import Contributors from './components/Contributors.vue'
import YouTubeEmbed from './components/YouTubeEmbed.vue'
import StackTable from './components/StackTable.vue'

// noinspection JSUnusedGlobalSymbols
export default {
Expand All @@ -13,5 +14,6 @@ export default {
app.component('Badge', VPBadge)
app.component('Contributors', Contributors)
app.component('YouTubeEmbed', YouTubeEmbed)
app.component('StackTable', StackTable)
},
}
12 changes: 4 additions & 8 deletions docs/docs/inputs.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Inputs

The inputs are organized in a table for quick [reference](#reference) with additional [details](#details) below.

## Reference

💡 You can click on an input for more [Details](#details).
💡 Click on the **Input Name** for more [Details](#details).

| Input&nbsp;Name | Default&nbsp;Value | Short&nbsp;Description&nbsp;of&nbsp;the&nbsp;Input&nbsp;Value |
| :------------------------------------ | :---------------------------------- | :------------------------------------------------------------ |
Expand Down Expand Up @@ -161,7 +157,7 @@ If you need compose file templating this can also be done in a previous step.

_Compose._ You can also add to the [args](#args) with `--env-file stringArray`.

::: tip IMPORTANT
::: info
**This is NOT** the Docker compose [env_file](https://docs.docker.com/compose/how-tos/environment-variables/set-environment-variables/#use-the-env_file-attribute) directive.
That is set in your compose file as normal.
:::
Expand All @@ -179,7 +175,7 @@ Default: `true`

### prune

Prune dangling images. Set to `true` to enable.
Prune services that are no longer referenced. Set to `true` to enable.

_See the [stack deploy Options](https://docs.docker.com/reference/cli/docker/stack/deploy/#options) for more details._

Expand Down Expand Up @@ -223,6 +219,6 @@ Required to run [docker login](https://docs.docker.com/reference/cli/docker/logi

Write a Summary for the job. To disable this set to `false`.

_For more information see [Job Summary](../guides/features.md#job-summary)._
For more information see [Job Summary](../guides/features.md#job-summary).

Default: `true`
2 changes: 1 addition & 1 deletion docs/guides/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ See the [Inputs Documentation](../docs/inputs.md) for more options.

You can [get started here](get-started.md) or view [workflow examples](examples.md).

::: info FEATURE REQUEST
::: tip Request a Feature
If you need more options, please [open a feature request](https://github.com/cssnr/stack-deploy-action/discussions/categories/feature-requests)
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,6 @@ For more details see the [README.md](https://github.com/cssnr/portainer-stack-de

&nbsp;

::: info FEATURE REQUEST
::: tip Request a Feature
If you need more options, please [open a feature request](https://github.com/cssnr/stack-deploy-action/discussions/categories/feature-requests)
:::
81 changes: 80 additions & 1 deletion docs/guides/resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,88 @@ A collection of resources and guides for getting started.

<YouTubeEmbed video-id="fuZoxuBiL9o" />

## Action Comparison

The majority of other actions available have not been recently updated
and most of them are forks and clones of each other.

This action was built from the ground up to deploy a Docker swarm stack
then updated to allow Docker compose deployments.

The goal of this action is to be the ultimate Docker deployment action on GitHub.
To date every [issue](https://github.com/cssnr/stack-deploy-action/issues) has been fixed
and all [feature requests](https://github.com/cssnr/stack-deploy-action/discussions/categories/feature-requests) have been added.

::: warning
None of these actions have been tested. This is an exhaustive list of published actions.
:::

<StackTable
:repos="[
'cssnr/stack-deploy-action',
'hoverkraft-tech/compose-action',
'wshihadeh/docker-deployment-action',
'TapTap21/docker-remote-deployment-action',
'kitconcept/docker-stack-deploy',
'serversideup/github-action-docker-swarm-deploy',
'matchory/docker-swarm-deployment-action',
'chaplyk/docker-compose-remote-action',
'matiasnu/github-action-ssh-docker-compose',
'astappiev/docker-compose-remote-action',
'sulthonzh/docker-remote-deployment-action',
'masterjanic/docker-compose-ssh-deployment',
'littleboyfury/ssh-docker-run',
'djnotes/github-action-ssh-docker-compose',
'hasnat/deploy-docker-compose',
'shockhs/docker-stack-deploy',
'open-fringecore/docker-ssh-push',
'alcharra/docker-deploy-action-go',
'erwanclx/docker-remote-deployment-action',
'humbertocrispim/ssh-docker-compose-action',
'jacobjove/deploy-docker-ssh',
'5eqn/docker-compose-remote-action',
'kamina7/docker-swarm-ssh-deploy-action',
'nightstory/setup-docker-remote',
'simbamarufu1/docker-swarm-deploy-action',
'Falling42/ssh-deploy',
'thomasvjoseph/ssh-docker',
'Vrashabh-Sontakke/docker-stack-deploy-action',
'prvious/ssh-docker',
'sidikfaha/deploy-docker',
'gronitab/docker-swarm-deploy-action',
'38ri581oq480/docker-run-command-remote-host-action',
'keatonLiu/docker-compose-remote-action',
'mannes/docker-remote-deployment-action',
'goldor8/custom-docker-compose-ssh-deployment',
'manugame/custom-docker-compose-ssh-deployment',
'hamidfzm/docker-remote-deployment-action',
'revelhome/stack-deploy-action',
'jrm402/docker-stack-deploy',
'sklimaszewski/dokploy-deploy-image-action',
'dombyte/docker-deploy',
'modcraftmc/custom-docker-compose-ssh-deployment',
'anilrajrimal1/ecr-docker-ssh-deployer',
'hantastic3/ssh-deploy-action',
'tristiisch/docker-stack-deployment',
'sovarto/deploy-swarm-service',
'leonidgrishenkov/docker-stack-deploy',
'harrisonratcliffe/github-action-docker-swarm-deploy',
'xfathurrahman/tailscale-stack-deploy-action',
'qdrx/stack-deploy-action',
'deriannavy/docker-context-action',
'Autom3/docker-deployment-action',
]"
</StackTable>

> **Updated** - Link to Pulse (activity)
> **Language** - Link to Dependants (users)

If there are any missing [features](../guides/features.md) you need,
please submit a [feature request](https://github.com/cssnr/stack-deploy-action/discussions/categories/feature-requests) and we will get them added...

&nbsp;

::: tip
::: tip Additional Resources
Have a related resource? Let us know by submitting a [PR](https://github.com/cssnr/stack-deploy-docs/edit/master/docs/guides/examples.md)
or opening an [Issue](https://github.com/cssnr/stack-deploy-docs/issues) on [GitHub](https://github.com/cssnr/stack-deploy-docs).
:::