Skip to content

Commit 4149497

Browse files
authored
Add documentation for channel input (#16)
* Fix action.yml * Fix readme with channel info * Minor documentation fixes
1 parent 8bc550b commit 4149497

2 files changed

Lines changed: 15 additions & 6 deletions

File tree

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ A [GitHub Action](https://github.com/features/actions) to deploy apps to any ser
2626

2727
## Inputs
2828
### `deploy_server`
29-
| Required | Description |
30-
| --- | --- |
31-
| **Yes** | The IP address of the SSH-enabled server to deploy to. |
29+
| Required | Default | Description |
30+
| --- | --- | --- |
31+
| **Yes** | N/A | The IP address of the SSH-enabled server to deploy to. |
3232

3333
### `deploy_username`
34-
| Required | Description |
35-
| --- | --- |
36-
| **Yes** | The username of the account associated with the provided SSH key to access on the deploy server. |
34+
| Required | Default | Description |
35+
| --- | --- | --- |
36+
| **Yes** | N/A | The username of the account associated with the provided SSH key to access on the deploy server. |
3737

3838
### `deploy_root_dir`
3939
| Required | Default | Description |
@@ -45,6 +45,11 @@ A [GitHub Action](https://github.com/features/actions) to deploy apps to any ser
4545
| --- | --- | --- |
4646
| **Yes** | N/A | The SSH key to be used to access the deploy server. |
4747

48+
### `channel`
49+
| Required | Default | Description |
50+
| --- | --- | --- |
51+
| No | `stable` | The IP address of the SSH-enabled server to deploy to. |
52+
4853
### `path`
4954
| Required | Default | Description |
5055
| --- | --- | --- |

action.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
name: 'Deploy'
22
description: 'Deploy Docker Compose app via SSH'
33
inputs:
4+
channel:
5+
description: 'The deployment channel'
6+
required: false
7+
default: 'stable'
48
deploy_server:
59
description: 'The SSH-enabled server to deploy to'
610
required: true

0 commit comments

Comments
 (0)