update doc

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

.github/main.workflow

@@ -1,45 +0,0 @@
-workflow "Remote ssh commands" {
-  on = "push"
-  resolves = [
-    "Executing remote ssh commands",
-    "Support Private Key",
-    "Multiple Commands",
-  ]
-}
-
-action "Executing remote ssh commands" {
-  uses = "appleboy/ssh-action@master"
-  secrets = [
-    "HOST",
-    "PASSWORD",
-  ]
-  args = [
-    "--user", "actions",
-    "--script", "whoami",
-  ]
-}
-
-action "Support Private Key" {
-  uses = "appleboy/ssh-action@master"
-  secrets = [
-    "HOST",
-    "KEY",
-  ]
-  args = [
-    "--user", "actions",
-    "--script", "'ls -al'",
-  ]
-}
-
-action "Multiple Commands" {
-  uses = "appleboy/ssh-action@master"
-  secrets = [
-    "HOST",
-    "KEY",
-  ]
-  args = [
-    "--user", "actions",
-    "--script", "'whoami'",
-    "--script", "'ls -al'",
-  ]
-}

.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+name: remote ssh command
+on: [push]
+jobs:
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+    - name: executing remote ssh commands using password
+      uses: appleboy/ssh-action@master
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USERNAME }}
+        password: ${{ secrets.PASSWORD }}
+        port: ${{ secrets.PORT }}
+        script: whoami
+
+    - name: executing remote ssh commands using ssh key
+      uses: appleboy/ssh-action@master
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USERNAME }}
+        key: ${{ secrets.KEY }}
+        port: ${{ secrets.PORT }}
+        script: whoami
+
+    - name: multiple command
+      uses: appleboy/ssh-action@master
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USERNAME }}
+        key: ${{ secrets.KEY }}
+        port: ${{ secrets.PORT }}
+        script: |
+          whoami
+          ls -al
+
+    # - name: stop script if command error
+    #   uses: appleboy/ssh-action@master
+    #   with:
+    #     host: ${{ secrets.HOST }}
+    #     username: ${{ secrets.USERNAME }}
+    #     key: ${{ secrets.KEY }}
+    #     port: ${{ secrets.PORT }}
+    #     script_stop: true
+    #     script: "mkdir abc/def,ls -al"
+
+    - name: pass environment
+      uses: appleboy/ssh-action@master
+      env:
+        FOO: "BAR"
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USERNAME }}
+        key: ${{ secrets.KEY }}
+        port: ${{ secrets.PORT }}
+        envs: FOO
+        script: |
+          echo "I am $FOO"
+          echo "I am $BAR"

Dockerfile

@@ -1,15 +1,4 @@
-FROM appleboy/drone-ssh:1.5.1-linux-amd64
+FROM appleboy/drone-ssh:1.5.2-linux-amd64
-
-# Github labels
-LABEL "com.github.actions.name"="SSH Commands"
-LABEL "com.github.actions.description"="Executing remote ssh commands"
-LABEL "com.github.actions.icon"="terminal"
-LABEL "com.github.actions.color"="gray-dark"
-
-LABEL "repository"="https://github.com/appleboy/ssh-action"
-LABEL "homepage"="https://github.com/appleboy"
-LABEL "maintainer"="Bo-Yi Wu <appleboy.tw@gmail.com>"
-LABEL "version"="0.0.2"
 
 ADD entrypoint.sh /entrypoint.sh
 RUN chmod +x /entrypoint.sh

README.md

@@ -1,132 +1,150 @@
 # 🚀 SSH for GitHub Actions
 
-[GitHub Action](https://developer.github.com/actions/) for executing remote ssh commands.
+[GitHub Action](https://github.com/features/actions) for executing remote ssh commands.
 
-<img src="./images/ssh-workflow.png">
+![ssh workflow](./images/ssh-workflow.png)
+
+[![Actions Status](https://github.com/appleboy/ssh-action/workflows/remote%20ssh%20command/badge.svg)](https://github.com/appleboy/ssh-action/actions)
 
 ## Usage
 
 Executing remote ssh commands.
 
-```
+```yaml
-action "Executing remote ssh commands" {
+name: remote ssh command
-  uses = "appleboy/ssh-action@master"
+on: [push]
-  secrets = [
+jobs:
-    "HOST",
+
-    "PASSWORD",
+  build:
-  ]
+    name: Build
-  args = [
+    runs-on: ubuntu-latest
-    "--user", "actions",
+    steps:
-    "--script", "whoami",
+    - name: executing remote ssh commands using password
-  ]
+      uses: appleboy/ssh-action@master
-}
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USERNAME }}
+        password: ${{ secrets.PASSWORD }}
+        port: ${{ secrets.PORT }}
+        script: whoami
 ```
 
-## Environment variables
+output:
 
-* HOST - ssh server host
+```sh
-* PORT - ssh server port
+======CMD======
-* USERNAME - ssh server username
+whoami
-* PASSWORD - ssh server password
+======END======
-* KEY - ssh server private key
+out: ***
-* SCRIPT - execute the scripts
+==========================================
+Successfully executed commands to all host.
+==========================================
+```
+
+## Input variables
+
+see the [action.yml](./action.yml) file for more detail imformation.
+
+* host - scp remote host
+* port - scp remote port, default is `22`
+* username - scp username
+* password - scp password
+* timeout - timeout for ssh to remote host, default is `30s`
+* command_timeout - timeout for scp command, default is `1m`
+* key - content of ssh private key. ex raw content of ~/.ssh/id_rsa
+* key_path - path of ssh private key
+* script - execute commands
+* script_stop - stop script after first failure
+* envs - pass environment variable to shell script
+* debug - enable debug mode
 
 ### Example
 
-Executing remote ssh commands.
+Executing remote ssh commands using password.
 
-```
+```yaml
-action "Executing remote ssh commands" {
+- name: executing remote ssh commands using password
-  uses = "appleboy/ssh-action@master"
+  uses: appleboy/ssh-action@master
-  secrets = [
+  with:
-    "PASSWORD",
+    host: ${{ secrets.HOST }}
-  ]
+    username: ${{ secrets.USERNAME }}
-  args = [
+    password: ${{ secrets.PASSWORD }}
-    "--host", "foo.com"
+    port: ${{ secrets.PORT }}
-    "--user", "bar",
+    script: whoami
-    "--script", "whoami",
-  ]
-}
 ```
 
 Using private key
 
-```
+```yaml
-action "Support Private Key" {
+- name: executing remote ssh commands using ssh key
-  uses = "appleboy/ssh-action@master"
+  uses: appleboy/ssh-action@master
-  secrets = [
+  with:
-    "HOST",
+    host: ${{ secrets.HOST }}
-    "KEY",
+    username: ${{ secrets.USERNAME }}
-  ]
+    key: ${{ secrets.KEY }}
-  args = [
+    port: ${{ secrets.PORT }}
-    "--user", "actions",
+    script: whoami
-    "--script", "'ls -al'",
-  ]
-}
 ```
 
 Multiple Commands
 
-```
+```yaml
-action "Multiple Commands" {
+- name: multiple command
-  uses = "appleboy/ssh-action@master"
+  uses: appleboy/ssh-action@master
-  secrets = [
+  with:
-    "HOST",
+    host: ${{ secrets.HOST }}
-    "KEY",
+    username: ${{ secrets.USERNAME }}
-  ]
+    key: ${{ secrets.KEY }}
-  args = [
+    port: ${{ secrets.PORT }}
-    "--user", "actions",
+    script: |
-    "--script", "'whoami'",
+      whoami
-    "--script", "'ls -al'",
+      ls -al
-  ]
-}
 ```
 
-<img src="./images/multiple-command-result.png">
+![result](./images/output-result.png)
 
 Multiple Hosts
 
-```
+```diff
-action "Multiple Hosts" {
+  uses: appleboy/ssh-action@master
-  uses = "appleboy/ssh-action@master"
+  with:
-  secrets = [
+-   host: "foo.com"
-    "KEY",
++   host: "foo.com,bar.com"
-  ]
+    username: ${{ secrets.USERNAME }}
-  args = [
+    key: ${{ secrets.KEY }}
-    "--host", "foo.com",
+    port: ${{ secrets.PORT }}
-    "--host", "bar.com",
+    script: |
-    "--user", "actions",
+      whoami
-    "--script", "'whoami'",
+      ls -al
-    "--script", "'ls -al'",
-    "--script", "'cat test.txt'",
-  ]
-}
 ```
 
-see the detail of `drone-ssh` command
+Pass environment variable to shell script
 
-```
+```diff
-   --ssh-key value                           private ssh key [$PLUGIN_SSH_KEY, $PLUGIN_KEY, $SSH_KEY, $KEY]
+  uses: appleboy/ssh-action@master
-   --key-path value, -i value                ssh private key path [$PLUGIN_KEY_PATH, $SSH_KEY_PATH, $PATH]
++ env:
-   --username value, --user value, -u value  connect as user (default: "root") [$PLUGIN_USERNAME, $PLUGIN_USER, $SSH_USERNAME, $USERNAME]
++   FOO: "BAR"
-   --password value, -P value                user password [$PLUGIN_PASSWORD, $SSH_PASSWORD, $PASSWORD]
+  with:
-   --host value, -H value                    connect to host [$PLUGIN_HOST, $SSH_HOST, $HOST]
+    host: ${{ secrets.HOST }}
-   --port value, -p value                    connect to port (default: 22) [$PLUGIN_PORT, $SSH_PORT, $PORT]
+    username: ${{ secrets.USERNAME }}
-   --sync                                    sync mode [$PLUGIN_SYNC, $SYNC]
+    key: ${{ secrets.KEY }}
-   --timeout value, -t value                 connection timeout (default: 0s) [$PLUGIN_TIMEOUT, $SSH_TIMEOUT, $TIMEOUT]
+    port: ${{ secrets.PORT }}
-   --command.timeout value, -T value         command timeout (default: 1m0s) [$PLUGIN_COMMAND_TIMEOUT, $SSH_COMMAND_TIMEOUT, $COMMAND_TIMEOUT]
++   envs: FOO
-   --script value, -s value                  execute commands [$PLUGIN_SCRIPT, $SSH_SCRIPT, $SCRIPT]
+    script: |
-   --script.stop                             stop script after first failure [$PLUGIN_SCRIPT_STOP, $STOP]
+      echo "I am $FOO"
-   --proxy.ssh-key value                     private ssh key of proxy [$PLUGIN_PROXY_SSH_KEY, $PLUGIN_PROXY_KEY, $PROXY_SSH_KEY]
+      echo "I am $BAR"
-   --proxy.key-path value                    ssh private key path of proxy [$PLUGIN_PROXY_KEY_PATH, $PROXY_SSH_KEY_PATH]
-   --proxy.username value                    connect as user of proxy (default: "root") [$PLUGIN_PROXY_USERNAME, $PLUGIN_PROXY_USER, $PROXY_SSH_USERNAME]
-   --proxy.password value                    user password of proxy [$PLUGIN_PROXY_PASSWORD, $PROXY_SSH_PASSWORD]
-   --proxy.host value                        connect to host of proxy [$PLUGIN_PROXY_HOST, $PROXY_SSH_HOST]
-   --proxy.port value                        connect to port of proxy (default: "22") [$PLUGIN_PROXY_PORT, $PROXY_SSH_PORT]
-   --proxy.timeout value                     proxy connection timeout (default: 0s) [$PLUGIN_PROXY_TIMEOUT, $PROXY_SSH_TIMEOUT]
 ```
 
-## Secrets
+Stop script after first failure. ex: missing `abc` folder
 
-* `PASSWORD` - ssh server password
+```yaml
-* `KEY` - ssh server private key
+- name: stop script if command error
+  uses: appleboy/ssh-action@master
+  with:
+    host: ${{ secrets.HOST }}
+    username: ${{ secrets.USERNAME }}
+    key: ${{ secrets.KEY }}
+    port: ${{ secrets.PORT }}
+    script_stop: true
+    script: "mkdir abc/def,ls -al"
+```

action.yml

@@ -0,0 +1,40 @@
+name: 'SSH Remote Commands'
+description: 'Executing remote ssh commands'
+author: 'Bo-Yi Wu'
+inputs:
+  host:
+    description: 'ssh remote host'
+  port:
+    description: 'ssh remote port'
+    default: 22
+  username:
+    description: 'ssh username'
+  password:
+    description: 'ssh password'
+  timeout:
+    description: 'timeout for ssh to remote host'
+    default: "30s"
+  command_timeout:
+    description: 'timeout for ssh command'
+    default: "1m"
+  key:
+    description: 'content of ssh private key. ex raw content of ~/.ssh/id_rsa'
+  key_path:
+    description: 'path of ssh private key'
+  script:
+    description: 'execute commands'
+  script_stop:
+    description: 'stop script after first failure'
+    default: false
+  envs:
+    description: 'pass environment variable to shell script'
+  debug:
+    description: 'enable debug mode'
+    default: false
+runs:
+  using: 'docker'
+  image: 'Dockerfile'
+
+branding:
+  icon: 'terminal'
+  color: 'gray-dark'