docs: update appleboy/ssh-action version in README

- Update the version of `appleboy/ssh-action` from `v0.1.10` to `v0.2.0` in multiple places in the README file.

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

.github/workflows/ci.yml

@@ -7,8 +7,8 @@ env:
 
 jobs:
 
-  build:
+  testing01:
-    name: Build
+    name: default flag testing
     runs-on: ubuntu-latest
     steps:
     - name: checkout
@@ -78,40 +78,6 @@ jobs:
           mkdir abc/def
           ls -al
 
-    - name: pass environment
-      uses: ./
-      env:
-        FOO: "BAR"
-      with:
-        host: ${{ secrets.HOST }}
-        username: ${{ secrets.USERNAME }}
-        key: ${{ secrets.KEY }}
-        port: ${{ secrets.PORT }}
-        envs: FOO
-        script: |
-          echo "I am $FOO, thanks"
-          echo "I am $BAR, thanks"
-
-    - name: pass multiple environment
-      uses: ./
-      env:
-        FOO: "BAR"
-        BAR: "FOO"
-        SHA: ${{ github.sha }}
-        PORT: ${{ secrets.PORT }}
-      with:
-        host: ${{ secrets.HOST }}
-        username: ${{ secrets.USERNAME }}
-        key: ${{ secrets.KEY }}
-        port: ${{ secrets.PORT }}
-        envs: FOO,BAR,SHA,PORT
-        script: |
-          echo "I am $FOO, thanks"
-          echo "I am $BAR, thanks"
-          echo "sha: $SHA"
-          echo "port: $PORT"
-          sh test.sh
-
     - name: ssh key passphrase
       uses: ./
       with:
@@ -172,3 +138,128 @@ jobs:
     #     key: ${{ secrets.ID_ED25519 }}
     #     port: ${{ secrets.TUNNEL_PORT }}
     #     script: whoami
+
+  testing02:
+    name: testing with envs
+    runs-on: ubuntu-latest
+    steps:
+    - name: checkout
+      uses: actions/checkout@v1
+
+    - name: pass environment
+      uses: ./
+      env:
+        FOO: "BAR"
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USERNAME }}
+        key: ${{ secrets.KEY }}
+        port: ${{ secrets.PORT }}
+        envs: FOO
+        script: |
+          echo "I am $FOO, thanks"
+          echo "I am $BAR, thanks"
+
+    - name: pass multiple environment
+      uses: ./
+      env:
+        FOO: "BAR"
+        BAR: "FOO"
+        SHA: ${{ github.sha }}
+        PORT: ${{ secrets.PORT }}
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USERNAME }}
+        key: ${{ secrets.KEY }}
+        port: ${{ secrets.PORT }}
+        envs: FOO,BAR,SHA,PORT
+        script: |
+          echo "I am $FOO, thanks"
+          echo "I am $BAR, thanks"
+          echo "sha: $SHA"
+          echo "port: $PORT"
+          sh test.sh
+
+    - name: custom envs format
+      uses: ./
+      env:
+        FOO: "BAR"
+        AAA: "BBB"
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USERNAME }}
+        key: ${{ secrets.KEY }}
+        port: ${{ secrets.PORT }}
+        envs: FOO,BAR,AAA
+        envs_format: export TEST_{NAME}={VALUE}
+        script: |
+          echo "I am $TEST_FOO, thanks"
+          echo "I am $TEST_BAR, thanks"
+          echo "I am $BAR, thanks"
+          echo "I am $TEST_AAA, thanks"
+
+    - name: pass all ENV variables to script
+      uses: ./
+      env:
+        INPUT_FOO: "BAR"
+        INPUT_AAA: "BBB"
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USERNAME }}
+        key: ${{ secrets.KEY }}
+        port: ${{ secrets.PORT }}
+        allenvs: true
+        script: |
+          echo "I am $INPUT_FOO, thanks"
+          echo "I am $INPUT_AAA, thanks"
+          echo "$GITHUB_BASE_REF"
+          echo "$GITHUB_REF"
+
+  testing03:
+    name: git clone and pull
+    runs-on: ubuntu-latest
+    steps:
+    - name: checkout
+      uses: actions/checkout@v1
+
+    - name: clone private repository
+      uses: ./
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USERNAME }}
+        key: ${{ secrets.KEY }}
+        port: ${{ secrets.PORT }}
+        script_stop: true
+        script: |
+          git clone https://appleboy:${{ secrets.TEST_TOKEN }}@github.com/go-training/self-runner.git test_repository
+          rm -rf test_repository
+
+  testing04:
+    name: docker login and pull
+    runs-on: ubuntu-latest
+    steps:
+    - name: checkout
+      uses: actions/checkout@v1
+
+    - name: login GitHub Container Registry
+      uses: ./
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USERNAME }}
+        key: ${{ secrets.KEY }}
+        port: ${{ secrets.PORT }}
+        script_stop: true
+        script: |
+          echo ${{ secrets.GITHUB_TOKEN }} | docker login ghcr.io -u github.actor --password-stdin
+
+    - name: login DockerHub Container Registry
+      uses: ./
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USERNAME }}
+        key: ${{ secrets.KEY }}
+        port: ${{ secrets.PORT }}
+        script_stop: true
+        script: |
+          echo ${{ secrets.DOCKERHUB_TOKEN }} | docker login -u ${{ secrets.DOCKERHUB_USERNAME }} --password-stdin
+

Dockerfile

@@ -1,4 +1,4 @@
-FROM ghcr.io/appleboy/drone-ssh:1.6.12
+FROM ghcr.io/appleboy/drone-ssh:1.7.0
 
 COPY entrypoint.sh /entrypoint.sh
 RUN chmod +x /entrypoint.sh

README.md

@@ -10,41 +10,44 @@
 
 **Important**: Only support **Linux** [docker](https://www.docker.com/) container.
 
+This thing is built using [Golang](https://go.dev) and [drone-ssh](https://github.com/appleboy/drone-ssh). 🚀
+
 ## Input variables
 
 See [action.yml](./action.yml) for more detailed information.
 
-* `host` - ssh host
+| Input Parameter         | Description                                                     | Default Value |
-* `port` - ssh port, default is `22`
+|-------------------------|-----------------------------------------------------------------|---------------|
-* `username` - ssh username
+| host                    | SSH host address                                                |               |
-* `password` - ssh password
+| port                    | SSH port number                                                 | 22            |
-* `passphrase` - the passphrase is usually to encrypt the private key
+| passphrase              | SSH key passphrase                                              |               |
-* `sync` - synchronous execution if multiple hosts, default is false
+| username                | SSH username                                                    |               |
-* `timeout` - timeout for ssh to remote host, default is `30s`
+| password                | SSH password                                                    |               |
-* `command_timeout` - timeout for ssh command, default is `10m`
+| sync                    | Enable synchronous execution if multiple hosts                  | false         |
-* `key` - content of ssh private key. ex raw content of ~/.ssh/id_rsa, remember include the BEGIN and END lines
+| use_insecure_cipher     | Include more ciphers with use_insecure_cipher                    | false         |
-* `key_path` - path of ssh private key
+| cipher                  | Allowed cipher algorithms. If unspecified, a sensible default   |               |
-* `fingerprint` - fingerprint SHA256 of the host public key, default is to skip verification
+| timeout                 | Timeout duration for SSH to host                                | 30s           |
-* `script` - execute commands
+| command_timeout         | Timeout duration for SSH command                                | 10m           |
-* `script_stop` - stop script after first failure
+| key                     | Content of SSH private key. e.g., raw content of ~/.ssh/id_rsa  |               |
-* `envs` - pass environment variable to shell script
+| key_path                | Path of SSH private key                                         |               |
-* `debug` - enable debug mode
+| fingerprint             | SHA256 fingerprint of the host public key                       |               |
-* `use_insecure_cipher` - include more ciphers with use_insecure_cipher (see [#56](https://github.com/appleboy/ssh-action/issues/56))
+| proxy_host              | SSH proxy host                                                  |               |
-* `cipher` - the allowed cipher algorithms. If unspecified then a sensible
+| proxy_port              | SSH proxy port                                                  | 22            |
-
+| proxy_username          | SSH proxy username                                              |               |
-SSH Proxy Setting:
+| proxy_password          | SSH proxy password                                              |               |
-
+| proxy_passphrase        | SSH proxy key passphrase                                        |               |
-* `proxy_host` - proxy host
+| proxy_timeout           | Timeout for SSH to proxy host                                    | 30s           |
-* `proxy_port` - proxy port, default is `22`
+| proxy_key               | Content of SSH proxy private key                                 |               |
-* `proxy_username` - proxy username
+| proxy_key_path          | Path of SSH proxy private key                                    |               |
-* `proxy_password` - proxy password
+| proxy_fingerprint       | SHA256 fingerprint of the proxy host public key                  |               |
-* `proxy_passphrase` - the passphrase is usually to encrypt the private key
+| proxy_cipher            | Allowed cipher algorithms for the proxy                          |               |
-* `proxy_timeout` - timeout for ssh to proxy host, default is `30s`
+| proxy_use_insecure_cipher | Include more ciphers with use_insecure_cipher for the proxy      | false         |
-* `proxy_key` - content of ssh proxy private key.
+| script                  | Execute commands                                                |               |
-* `proxy_key_path` - path of ssh proxy private key
+| script_stop             | Stop script after first failure                                  | false         |
-* `proxy_fingerprint` - fingerprint SHA256 of the proxy host public key, default is to skip verification
+| envs                    | Pass environment variables to shell script                      |               |
-* `proxy_use_insecure_cipher` - include more ciphers with use_insecure_cipher (see [#56](https://github.com/appleboy/ssh-action/issues/56))
+| envs_format             | Flexible configuration of environment value transfer            |               |
-* `proxy_cipher` - the allowed cipher algorithms. If unspecified then a sensible
+| debug                   | Enable debug mode                                               | false         |
+| allenvs                 | Pass all environment variables to shell script                  | false         |
 
 ## Usage
 
@@ -60,7 +63,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: executing remote ssh commands using password
-      uses: appleboy/ssh-action@v0.1.9
+      uses: appleboy/ssh-action@v0.2.0
       with:
         host: ${{ secrets.HOST }}
         username: ${{ secrets.USERNAME }}
@@ -161,7 +164,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```yaml
 - name: executing remote ssh commands using password
-  uses: appleboy/ssh-action@v0.1.9
+  uses: appleboy/ssh-action@v0.2.0
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -174,7 +177,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```yaml
 - name: executing remote ssh commands using ssh key
-  uses: appleboy/ssh-action@v0.1.9
+  uses: appleboy/ssh-action@v0.2.0
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -187,7 +190,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```yaml
 - name: multiple command
-  uses: appleboy/ssh-action@v0.1.9
+  uses: appleboy/ssh-action@v0.2.0
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -204,7 +207,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```diff
   - name: multiple host
-    uses: appleboy/ssh-action@v0.1.9
+    uses: appleboy/ssh-action@v0.2.0
     with:
 -     host: "foo.com"
 +     host: "foo.com,bar.com"
@@ -220,7 +223,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```diff
   - name: multiple host
-    uses: appleboy/ssh-action@v0.1.9
+    uses: appleboy/ssh-action@v0.2.0
     with:
 -     host: "foo.com"
 +     host: "foo.com:1234,bar.com:5678"
@@ -235,7 +238,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```diff
   - name: multiple host
-    uses: appleboy/ssh-action@v0.1.9
+    uses: appleboy/ssh-action@v0.2.0
     with:
       host: "foo.com,bar.com"
 +     sync: true
@@ -251,7 +254,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```diff
   - name: pass environment
-    uses: appleboy/ssh-action@v0.1.9
+    uses: appleboy/ssh-action@v0.2.0
 +   env:
 +     FOO: "BAR"
 +     BAR: "FOO"
@@ -276,7 +279,7 @@ _Inside `env` object, you need to pass every environment variable as a string, p
 
 ```diff
   - name: stop script if command error
-    uses: appleboy/ssh-action@v0.1.9
+    uses: appleboy/ssh-action@v0.2.0
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -329,7 +332,7 @@ Host FooServer
 
 ```diff
   - name: ssh proxy command
-    uses: appleboy/ssh-action@v0.1.9
+    uses: appleboy/ssh-action@v0.2.0
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -352,7 +355,7 @@ It is not uncommon for files to leak from backups or decommissioned hardware, an
 
 ```diff
   - name: ssh key passphrase
-    uses: appleboy/ssh-action@v0.1.9
+    uses: appleboy/ssh-action@v0.2.0
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -378,7 +381,7 @@ Now you can adjust you config:
 
 ```diff
   - name: ssh key passphrase
-    uses: appleboy/ssh-action@v0.1.9
+    uses: appleboy/ssh-action@v0.2.0
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}

README.zh-tw.md

@@ -58,7 +58,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: executing remote ssh commands using password
-      uses: appleboy/ssh-action@v0.1.9
+      uses: appleboy/ssh-action@v0.1.10
       with:
         host: ${{ secrets.HOST }}
         username: ${{ secrets.USERNAME }}
@@ -157,7 +157,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```yaml
 - name: executing remote ssh commands using password
-  uses: appleboy/ssh-action@v0.1.9
+  uses: appleboy/ssh-action@v0.1.10
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -170,7 +170,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```yaml
 - name: executing remote ssh commands using ssh key
-  uses: appleboy/ssh-action@v0.1.9
+  uses: appleboy/ssh-action@v0.1.10
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -183,7 +183,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```yaml
 - name: multiple command
-  uses: appleboy/ssh-action@v0.1.9
+  uses: appleboy/ssh-action@v0.1.10
   with:
     host: ${{ secrets.HOST }}
     username: ${{ secrets.USERNAME }}
@@ -200,7 +200,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```diff
   - name: multiple host
-    uses: appleboy/ssh-action@v0.1.9
+    uses: appleboy/ssh-action@v0.1.10
     with:
 -     host: "foo.com"
 +     host: "foo.com,bar.com"
@@ -216,7 +216,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```diff
   - name: multiple host
-    uses: appleboy/ssh-action@v0.1.9
+    uses: appleboy/ssh-action@v0.1.10
     with:
 -     host: "foo.com"
 +     host: "foo.com:1234,bar.com:5678"
@@ -231,7 +231,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```diff
   - name: multiple host
-    uses: appleboy/ssh-action@v0.1.9
+    uses: appleboy/ssh-action@v0.1.10
     with:
       host: "foo.com,bar.com"
 +     sync: true
@@ -247,7 +247,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 ```diff
   - name: pass environment
-    uses: appleboy/ssh-action@v0.1.9
+    uses: appleboy/ssh-action@v0.1.10
 +   env:
 +     FOO: "BAR"
 +     BAR: "FOO"
@@ -272,7 +272,7 @@ _在 `env` 對象中，您需要將每個環境變量作為字符串傳遞，傳
 
 ```diff
   - name: stop script if command error
-    uses: appleboy/ssh-action@v0.1.9
+    uses: appleboy/ssh-action@v0.1.10
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -325,7 +325,7 @@ Host FooServer
 
 ```diff
   - name: ssh proxy command
-    uses: appleboy/ssh-action@v0.1.9
+    uses: appleboy/ssh-action@v0.1.10
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -346,7 +346,7 @@ Host FooServer
 
 ```diff
   - name: ssh key passphrase
-    uses: appleboy/ssh-action@v0.1.9
+    uses: appleboy/ssh-action@v0.1.10
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}
@@ -372,7 +372,7 @@ ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ' '
 
 ```diff
   - name: ssh key passphrase
-    uses: appleboy/ssh-action@v0.1.9
+    uses: appleboy/ssh-action@v0.1.10
     with:
       host: ${{ secrets.HOST }}
       username: ${{ secrets.USERNAME }}

action.yml

@@ -3,71 +3,70 @@ description: 'Executing remote ssh commands'
 author: 'Bo-Yi Wu'
 inputs:
   host:
-    description: 'ssh host'
+    description: 'SSH host address.'
   port:
-    description: 'ssh port'
+    description: 'SSH port number.'
-    default: 22
+    default: "22"
   passphrase:
-    description: 'ssh key passphrase'
+    description: 'Passphrase for the SSH key.'
   username:
-    description: 'ssh username'
+    description: 'SSH username.'
   password:
-    description: 'ssh password'
+    description: 'SSH password.'
   sync:
-    description: 'synchronous execution if multiple hosts'
+    description: 'Enable synchronous execution if multiple hosts are involved.'
-    default: false
   use_insecure_cipher:
-    description: 'include more ciphers with use_insecure_cipher'
+    description: 'Include more ciphers by using insecure ciphers.'
-    default: false
   cipher:
-    description: 'the allowed cipher algorithms. If unspecified then a sensible'
+    description: 'Allowed cipher algorithms. If unspecified, a sensible default is used.'
   timeout:
-    description: 'timeout for ssh to host'
+    description: 'Timeout duration for establishing SSH connection to the host.'
     default: "30s"
   command_timeout:
-    description: 'timeout for ssh command'
+    description: 'Timeout duration for SSH commands execution.'
     default: "10m"
   key:
-    description: 'content of ssh private key. ex raw content of ~/.ssh/id_rsa'
+    description: 'Content of the SSH private key. For example, the raw content of ~/.ssh/id_rsa.'
   key_path:
-    description: 'path of ssh private key'
+    description: 'Path to the SSH private key file.'
   fingerprint:
-    description: 'sha256 fingerprint of the host public key'
+    description: 'SHA256 fingerprint of the host public key.'
   proxy_host:
-    description: 'ssh proxy host'
+    description: 'SSH proxy host address.'
   proxy_port:
-    description: 'ssh proxy port'
+    description: 'SSH proxy port number.'
-    default: 22
+    default: "22"
   proxy_username:
-    description: 'ssh proxy username'
+    description: 'SSH proxy username.'
   proxy_password:
-    description: 'ssh proxy password'
+    description: 'SSH proxy password.'
   proxy_passphrase:
-    description: 'ssh proxy key passphrase'
+    description: 'SSH proxy key passphrase.'
   proxy_timeout:
-    description: 'timeout for ssh to proxy host'
+    description: 'Timeout duration for establishing SSH connection to the proxy host.'
     default: "30s"
   proxy_key:
-    description: 'content of ssh proxy private key. ex raw content of ~/.ssh/id_rsa'
+    description: 'Content of the SSH proxy private key. For example, the raw content of ~/.ssh/id_rsa.'
   proxy_key_path:
-    description: 'path of ssh proxy private key'
+    description: 'Path to the SSH proxy private key file.'
   proxy_fingerprint:
-    description: 'sha256 fingerprint of the proxy host public key'
+    description: 'SHA256 fingerprint of the proxy host public key.'
   proxy_cipher:
-    description: 'the allowed cipher algorithms. If unspecified then a sensible'
+    description: 'Allowed cipher algorithms for the proxy. If unspecified, a sensible default is used.'
   proxy_use_insecure_cipher:
-    description: 'include more ciphers with use_insecure_cipher'
+    description: 'Include more ciphers for the proxy by using insecure ciphers.'
-    default: false
   script:
-    description: 'execute commands'
+    description: 'Commands to be executed.'
   script_stop:
-    description: 'stop script after first failure'
+    description: 'Stop the script after the first failure.'
-    default: false
   envs:
-    description: 'pass environment variable to shell script'
+    description: 'Environment variables to be passed to the shell script.'
+  envs_format:
+    description: 'Flexible configuration for environment value transfer.'
   debug:
-    description: 'enable debug mode'
+    description: 'Enable debug mode.'
-    default: false
+  allenvs:
+    description: 'pass all environment variable to shell script.'
 runs:
   using: 'docker'
   image: 'Dockerfile'