chore: standardize formatting and update dependencies in workflows

- Change the title format in the bug report template from single quotes to double quotes - Update `appleboy/ssh-action` version from `v1.2.0` to `v1.2.1` in multiple workflow files - Remove unnecessary blank lines in the bug report template Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
docs: standardize script_file naming to script_path in documentation (#360 )
2025-07-23 11:17:00 +00:00 · 2025-02-19 17:50:00 +08:00 · 2025-01-03 10:17:01 +08:00 · 2025-01-03 09:31:39 +08:00 · 2024-12-05 16:23:32 +08:00 · 2024-12-04 09:49:35 +08:00
8 changed files with 301 additions and 68 deletions
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@ -1,10 +1,9 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
+title: ""
 labels: bug
 assignees: appleboy
-
 ---

 ## Describe the bug
@ -19,19 +18,18 @@ Please post your Yaml configuration file along with the output results.
 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@v1.2.0
-      with:
-        host: ${{ secrets.HOST }}
-        username: ${{ secrets.USERNAME }}
-        password: ${{ secrets.PASSWORD }}
-        port: ${{ secrets.PORT }}
-        script: whoami
+      - name: executing remote ssh commands using password
+        uses: appleboy/ssh-action@v1.2.1
+        with:
+          host: ${{ secrets.HOST }}
+          username: ${{ secrets.USERNAME }}
+          password: ${{ secrets.PASSWORD }}
+          port: ${{ secrets.PORT }}
+          script: whoami
 ```

 ## Related environment
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@ -504,3 +504,221 @@ jobs:
          command_timeout: 30s
          script: |
            whoami
+
+  testing07:
+    name: some special character
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+
+      - name: Set Environment Variables
+        run: |
+          PASS='3HUS$?8kLu)}'
+          printf "PASS=${PASS}" >> $GITHUB_ENV
+
+      - name: create new ssh server
+        run: |
+          docker run -d \
+          --name=openssh-server \
+          --hostname=openssh-server \
+          -p 2222:2222 \
+          -e SUDO_ACCESS=false \
+          -e PASSWORD_ACCESS=true  \
+          -e USER_PASSWORD='${{ env.PASS }}'  \
+          -e USER_NAME=linuxserver.io \
+          --restart unless-stopped \
+          lscr.io/linuxserver/openssh-server:latest
+          docker exec openssh-server sh -c "hostname -i" > ip.txt
+          echo "REMOTE_HOST<<EOF" >> $GITHUB_ENV
+          cat ip.txt >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+          echo "======= container ip address ========="
+          cat ip.txt
+          echo "======================================"
+          sleep 2
+
+      - name: ssh by username and password
+        uses: ./
+        with:
+          host: ${{ env.REMOTE_HOST }}
+          username: linuxserver.io
+          password: ${{ env.PASS }}
+          port: 2222
+          script: |
+            #!/usr/bin/env bash
+            set -e
+            whoami
+
+  testing-capturing-output:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: create new ssh server
+        run: |
+          docker run -d \
+          --name=openssh-server \
+          --hostname=openssh-server \
+          -p 2222:2222 \
+          -e SUDO_ACCESS=false \
+          -e PASSWORD_ACCESS=true  \
+          -e USER_PASSWORD=password  \
+          -e USER_NAME=linuxserver.io \
+          --restart unless-stopped \
+          lscr.io/linuxserver/openssh-server:latest
+          docker exec openssh-server sh -c "hostname -i" > ip.txt
+          echo "REMOTE_HOST<<EOF" >> $GITHUB_ENV
+          cat ip.txt >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+          echo "======= container ip address ========="
+          cat ip.txt
+          echo "======================================"
+          sleep 2
+
+      - id: stdout
+        name: ssh command with stdout
+        uses: ./
+        with:
+          host: ${{ env.REMOTE_HOST }}
+          username: linuxserver.io
+          password: password
+          port: 2222
+          capture_stdout: true
+          script: |
+            #!/usr/bin/env bash
+            set -e
+            whoami
+
+      - name: check stdout
+        run: |
+          echo "stdout: ${{ steps.stdout.outputs.stdout }}"
+
+  testing-script-stop:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: create new ssh server
+        run: |
+          docker run -d \
+          --name=openssh-server \
+          --hostname=openssh-server \
+          -p 2222:2222 \
+          -e SUDO_ACCESS=false \
+          -e PASSWORD_ACCESS=true  \
+          -e USER_PASSWORD=password  \
+          -e USER_NAME=linuxserver.io \
+          --restart unless-stopped \
+          lscr.io/linuxserver/openssh-server:latest
+          docker exec openssh-server sh -c "hostname -i" > ip.txt
+          echo "REMOTE_HOST<<EOF" >> $GITHUB_ENV
+          cat ip.txt >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+          echo "======= container ip address ========="
+          cat ip.txt
+          echo "======================================"
+          sleep 2
+
+      - id: stdout01
+        name: ssh command with stdout 01
+        uses: ./
+        with:
+          host: ${{ env.REMOTE_HOST }}
+          username: linuxserver.io
+          password: password
+          port: 2222
+          capture_stdout: true
+          script: |
+            #!/usr/bin/env bash
+            set -e
+            echo "TMP TESTING IF"
+            if [[ "2" == "1" ]]; then
+              echo "True"
+            else
+              echo "False"
+            fi
+
+      - name: check stdout 01
+        run: |
+          echo "stdout: ${{ steps.stdout01.outputs.stdout }}"
+          if echo "${{ steps.stdout01.outputs.stdout }}" | grep -q "True"; then
+            echo "Output contains 'True'"
+            exit 1
+          fi
+          if echo "${{ steps.stdout01.outputs.stdout }}" | grep -q "False"; then
+            echo "Output contains 'False'"
+          fi
+
+      - id: stdout02
+        name: ssh command with stdout 01
+        uses: ./
+        with:
+          host: ${{ env.REMOTE_HOST }}
+          username: linuxserver.io
+          password: password
+          port: 2222
+          capture_stdout: true
+          script: |
+            #!/usr/bin/env bash
+            set -e
+            echo "TMP TESTING IF"
+            if [[ "1" == "1" ]]; then
+              echo "True"
+            else
+              echo "False"
+            fi
+
+      - name: check stdout 02
+        run: |
+          echo "stdout: ${{ steps.stdout02.outputs.stdout }}"
+          if echo "${{ steps.stdout02.outputs.stdout }}" | grep -q "False"; then
+            echo "Output contains 'False'"
+            exit 1
+          fi
+          if echo "${{ steps.stdout02.outputs.stdout }}" | grep -q "True"; then
+            echo "Output contains 'True'"
+          fi
+
+  testing-script-error:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: create new ssh server
+        run: |
+          docker run -d \
+          --name=openssh-server \
+          --hostname=openssh-server \
+          -p 2222:2222 \
+          -e SUDO_ACCESS=false \
+          -e PASSWORD_ACCESS=true  \
+          -e USER_PASSWORD=password  \
+          -e USER_NAME=linuxserver.io \
+          --restart unless-stopped \
+          lscr.io/linuxserver/openssh-server:latest
+          docker exec openssh-server sh -c "hostname -i" > ip.txt
+          echo "REMOTE_HOST<<EOF" >> $GITHUB_ENV
+          cat ip.txt >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+          echo "======= container ip address ========="
+          cat ip.txt
+          echo "======================================"
+          sleep 2
+
+      - name: test script error
+        uses: ./
+        continue-on-error: true
+        with:
+          host: ${{ env.REMOTE_HOST }}
+          username: linuxserver.io
+          password: password
+          port: 2222
+          capture_stdout: true
+          script: |
+            #!/usr/bin/env bash
+            set -e
+            ls /nonexistent
--- a/.github/workflows/stable.yml
+++ b/.github/workflows/stable.yml
@ -31,7 +31,7 @@ jobs:
          sleep 2

      - name: ssh by username and password
-        uses: appleboy/ssh-action@v1.2.0
+        uses: appleboy/ssh-action@v1.2.1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
@ -43,7 +43,7 @@ jobs:
            whoami

      - name: ssh commands from a file
-        uses: appleboy/ssh-action@v1.2.0
+        uses: appleboy/ssh-action@v1.2.1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
@ -95,7 +95,7 @@ jobs:
          sleep 2

      - name: ssh by private key
-        uses: appleboy/ssh-action@v1.2.0
+        uses: appleboy/ssh-action@v1.2.1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
@ -104,7 +104,7 @@ jobs:
          script: whoami

      - name: wrong password but correct key
-        uses: appleboy/ssh-action@v1.2.0
+        uses: appleboy/ssh-action@v1.2.1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
@ -114,7 +114,7 @@ jobs:
          script: whoami

      - name: correct password but wrong key
-        uses: appleboy/ssh-action@v1.2.0
+        uses: appleboy/ssh-action@v1.2.1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
@ -167,7 +167,7 @@ jobs:
          sleep 2

      - name: ssh key passphrase
-        uses: appleboy/ssh-action@v1.2.0
+        uses: appleboy/ssh-action@v1.2.1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
@ -179,7 +179,7 @@ jobs:
            ls -al

      - name: missing ssh key passphrase
-        uses: appleboy/ssh-action@v1.2.0
+        uses: appleboy/ssh-action@v1.2.1
        continue-on-error: true
        with:
          host: ${{ env.REMOTE_HOST }}
@ -192,7 +192,7 @@ jobs:

      # https://github.com/appleboy/ssh-action/issues/75#issuecomment-668314271
      - name: Multiline SSH commands interpreted as single lines
-        uses: appleboy/ssh-action@v1.2.0
+        uses: appleboy/ssh-action@v1.2.1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
@ -269,7 +269,7 @@ jobs:

      # https://github.com/appleboy/ssh-action/issues/85
      - name: Deployment to multiple hosts with different ports
-        uses: appleboy/ssh-action@v1.2.0
+        uses: appleboy/ssh-action@v1.2.1
        with:
          host: "${{ env.REMOTE_HOST_01 }}:2222,${{ env.REMOTE_HOST_02 }}:2222"
          username: linuxserver.io
@ -322,7 +322,7 @@ jobs:
          sleep 2

      - name: testing id_ed25519 key
-        uses: appleboy/ssh-action@v1.2.0
+        uses: appleboy/ssh-action@v1.2.1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
@ -375,7 +375,7 @@ jobs:
          sleep 2

      - name: testing id_ed25519 key
-        uses: appleboy/ssh-action@v1.2.0
+        uses: appleboy/ssh-action@v1.2.1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
@ -386,7 +386,7 @@ jobs:
            ls -al

      - name: pass environment
-        uses: appleboy/ssh-action@v1.2.0
+        uses: appleboy/ssh-action@v1.2.1
        env:
          FOO: "BAR"
        with:
@ -400,7 +400,7 @@ jobs:
            echo "I am $BAR, thanks"

      - name: pass multiple environment
-        uses: appleboy/ssh-action@v1.2.0
+        uses: appleboy/ssh-action@v1.2.1
        env:
          FOO: "BAR"
          BAR: "FOO"
@ -419,7 +419,7 @@ jobs:
            echo "port: $PORT"

      - name: custom envs format
-        uses: appleboy/ssh-action@v1.2.0
+        uses: appleboy/ssh-action@v1.2.1
        env:
          FOO: "BAR"
          AAA: "BBB"
@ -437,7 +437,7 @@ jobs:
            echo "I am $TEST_AAA, thanks"

      - name: pass all ENV variables to script
-        uses: appleboy/ssh-action@v1.2.0
+        uses: appleboy/ssh-action@v1.2.1
        env:
          INPUT_FOO: "BAR"
          INPUT_AAA: "BBB"
@ -454,7 +454,7 @@ jobs:
            echo "$GITHUB_REF"

      - name: switch to root user
-        uses: appleboy/ssh-action@v1.2.0
+        uses: appleboy/ssh-action@v1.2.1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
--- a/README.md
+++ b/README.md
@ -43,7 +43,7 @@ See [action.yml](./action.yml) for more detailed information.
 | proxy_cipher              | Allowed cipher algorithms for the proxy                                                  |               |
 | proxy_use_insecure_cipher | Include more ciphers with use_insecure_cipher for the proxy                              | false         |
 | script                    | Execute commands                                                                         |               |
-| script_file               | Execute commands from a file                                                             |               |
+| script_path               | Execute commands from a file                                                             |               |
 | envs                      | Pass environment variables to shell script                                               |               |
 | envs_format               | Flexible configuration of environment value transfer                                     |               |
 | debug                     | Enable debug mode                                                                        | false         |
@ -63,7 +63,7 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - name: executing remote ssh commands using password
-        uses: appleboy/ssh-action@v1.2.0
+        uses: appleboy/ssh-action@v1.2.1
        with:
          host: ${{ secrets.HOST }}
          username: linuxserver.io
@ -179,7 +179,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```yaml
 - name: executing remote ssh commands using password
-  uses: appleboy/ssh-action@v1.2.0
+  uses: appleboy/ssh-action@v1.2.1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@ -192,7 +192,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@v1.2.0
+  uses: appleboy/ssh-action@v1.2.1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@ -205,7 +205,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```yaml
 - name: multiple command
-  uses: appleboy/ssh-action@v1.2.0
+  uses: appleboy/ssh-action@v1.2.1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@ -222,7 +222,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```yaml
 - name: file commands
-  uses: appleboy/ssh-action@v1.2.0
+  uses: appleboy/ssh-action@v1.2.1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@ -235,7 +235,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
    with:
 -     host: "foo.com"
 +     host: "foo.com,bar.com"
@ -253,7 +253,7 @@ The default value of `port` is `22`.

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
    with:
 -     host: "foo.com"
 +     host: "foo.com:1234,bar.com:5678"
@ -268,7 +268,7 @@ The default value of `port` is `22`.

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
    with:
      host: "foo.com,bar.com"
 +     sync: true
@ -284,7 +284,7 @@ The default value of `port` is `22`.

 ```diff
  - name: pass environment
-    uses: appleboy/ssh-action@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
 +   env:
 +     FOO: "BAR"
 +     BAR: "FOO"
@ -331,7 +331,7 @@ Host FooServer

 ```diff
  - name: ssh proxy command
-    uses: appleboy/ssh-action@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
@ -354,7 +354,7 @@ It is not uncommon for files to leak from backups or decommissioned hardware, an

 ```diff
  - name: ssh key passphrase
-    uses: appleboy/ssh-action@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
@ -380,7 +380,7 @@ Now you can adjust you config:

 ```diff
  - name: ssh key passphrase
-    uses: appleboy/ssh-action@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
--- a/README.zh-cn.md
+++ b/README.zh-cn.md
@ -43,7 +43,7 @@
 | proxy_cipher              | 代理允许的密码算法                                    |        |
 | proxy_use_insecure_cipher | 使用不安全的密码算法                                  | false  |
 | script                    | 执行命令                                              |        |
-| script_file               | 从文件执行命令                                        |        |
+| script_path               | 从文件执行命令                                        |        |
 | envs                      | 传递环境变量到 shell 脚本                             |        |
 | envs_format               | 环境变量传递的灵活配置                                |        |
 | debug                     | 启用调试模式                                          | false  |
@ -63,7 +63,7 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - name: executing remote ssh commands using password
-        uses: appleboy/ssh-action@v1.2.0
+        uses: appleboy/ssh-action@v1.2.1
        with:
          host: ${{ secrets.HOST }}
          username: ${{ secrets.USERNAME }}
@ -162,7 +162,7 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“

 ```yaml
 - name: executing remote ssh commands using password
-  uses: appleboy/ssh-action@v1.2.0
+  uses: appleboy/ssh-action@v1.2.1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@ -175,7 +175,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@v1.2.0
+  uses: appleboy/ssh-action@v1.2.1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@ -188,7 +188,7 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“

 ```yaml
 - name: multiple command
-  uses: appleboy/ssh-action@v1.2.0
+  uses: appleboy/ssh-action@v1.2.1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@ -205,7 +205,7 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
    with:
 -     host: ”foo.com“
 +     host: ”foo.com,bar.com“
@ -221,7 +221,7 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“

 ```yaml
 - name: file commands
-  uses: appleboy/ssh-action@v1.2.0
+  uses: appleboy/ssh-action@v1.2.1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@ -234,7 +234,7 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
    with:
 -     host: ”foo.com“
 +     host: ”foo.com:1234,bar.com:5678“
@ -249,7 +249,7 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
    with:
      host: ”foo.com,bar.com“
 +     sync: true
@ -265,7 +265,7 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“

 ```diff
  - name: pass environment
-    uses: appleboy/ssh-action@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
 +   env:
 +     FOO: ”BAR“
 +     BAR: ”FOO“
@ -312,7 +312,7 @@ Host FooServer

 ```diff
  - name: ssh proxy command
-    uses: appleboy/ssh-action@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
@ -333,7 +333,7 @@ Host FooServer

 ```diff
  - name: ssh key passphrase
-    uses: appleboy/ssh-action@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
@ -359,7 +359,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@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
--- a/README.zh-tw.md
+++ b/README.zh-tw.md
@ -43,7 +43,7 @@
 | proxy_cipher              | 代理允許的加密算法                                    |        |
 | proxy_use_insecure_cipher | 包含更多不安全的加密算法                              | false  |
 | script                    | 執行命令                                              |        |
-| script_file               | 從文件中執行命令                                      |        |
+| script_path               | 從文件中執行命令                                      |        |
 | envs                      | 將環境變數傳遞給 shell 腳本                           |        |
 | envs_format               | 環境值傳遞的靈活配置                                  |        |
 | debug                     | 啟用調試模式                                          | false  |
@ -63,7 +63,7 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - name: executing remote ssh commands using password
-        uses: appleboy/ssh-action@v1.2.0
+        uses: appleboy/ssh-action@v1.2.1
        with:
          host: ${{ secrets.HOST }}
          username: ${{ secrets.USERNAME }}
@ -162,7 +162,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```yaml
 - name: executing remote ssh commands using password
-  uses: appleboy/ssh-action@v1.2.0
+  uses: appleboy/ssh-action@v1.2.1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@ -175,7 +175,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@v1.2.0
+  uses: appleboy/ssh-action@v1.2.1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@ -188,7 +188,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```yaml
 - name: multiple command
-  uses: appleboy/ssh-action@v1.2.0
+  uses: appleboy/ssh-action@v1.2.1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@ -205,7 +205,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```yaml
 - name: file commands
-  uses: appleboy/ssh-action@v1.2.0
+  uses: appleboy/ssh-action@v1.2.1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@ -218,7 +218,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
    with:
 -     host: "foo.com"
 +     host: "foo.com,bar.com"
@ -234,7 +234,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
    with:
 -     host: "foo.com"
 +     host: "foo.com:1234,bar.com:5678"
@ -249,7 +249,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
    with:
      host: "foo.com,bar.com"
 +     sync: true
@ -265,7 +265,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```diff
  - name: pass environment
-    uses: appleboy/ssh-action@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
 +   env:
 +     FOO: "BAR"
 +     BAR: "FOO"
@ -312,7 +312,7 @@ Host FooServer

 ```diff
  - name: ssh proxy command
-    uses: appleboy/ssh-action@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
@ -333,7 +333,7 @@ Host FooServer

 ```diff
  - name: ssh key passphrase
-    uses: appleboy/ssh-action@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
@ -359,7 +359,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@v1.2.0
+    uses: appleboy/ssh-action@v1.2.1
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
--- a/action.yml
+++ b/action.yml
@ -75,6 +75,14 @@ inputs:
    description: "pass all environment variable to shell script."
  request_pty:
    description: "Request a pseudo-terminal from the server."
+  capture_stdout:
+    description: "Capture the stdout of the commands."
+    default: "false"
+
+outputs:
+  stdout:
+    description: 'Standard output of the executed commands.'
+    value: ${{ steps.entrypoint.outputs.stdout }}

 runs:
  using: "composite"
@ -84,7 +92,8 @@ runs:
      shell: bash
      env:
        GITHUB_ACTION_PATH: ${{ github.action_path }}
-    - name: Run entrypoint.sh
+    - id: entrypoint
+      name: Run entrypoint.sh
      run: entrypoint.sh
      shell: bash
      env:
@ -121,6 +130,7 @@ runs:
        INPUT_PROXY_USE_INSECURE_CIPHER: ${{ inputs.proxy_use_insecure_cipher }}
        INPUT_PROXY_CIPHER: ${{ inputs.proxy_cipher }}
        INPUT_SYNC: ${{ inputs.sync }}
+        INPUT_CAPTURE_STDOUT: ${{ inputs.capture_stdout }}

 branding:
  icon: "terminal"
--- a/entrypoint.sh
+++ b/entrypoint.sh
@ -64,7 +64,14 @@ TARGET="${GITHUB_ACTION_PATH}/${CLIENT_BINARY}"
 echo "Will download ${CLIENT_BINARY} from ${DOWNLOAD_URL_PREFIX}"
 curl -fsSL --retry 5 --keepalive-time 2 "${DOWNLOAD_URL_PREFIX}/${CLIENT_BINARY}" -o ${TARGET}
 chmod +x ${TARGET}
+
 echo "======= CLI Version ======="
 sh -c "${TARGET} --version" # print version
 echo "==========================="
-sh -c "${TARGET} $*" # run the command
+if [[ "$INPUT_CAPTURE_STDOUT" == 'true' ]]; then
+  echo 'stdout<<EOF' >> $GITHUB_OUTPUT # use heredoc for multiline output
+  sh -c "${TARGET} $*" | tee -a $GITHUB_OUTPUT # run the command
+  echo 'EOF' >> $GITHUB_OUTPUT
+else
+  sh -c "${TARGET} $*" # run the command
+fi
Author	SHA1	Message	Date
Bo-Yi Wu	8faa84277b	chore: standardize formatting and update dependencies in workflows - Change the title format in the bug report template from single quotes to double quotes - Update `appleboy/ssh-action` version from `v1.2.0` to `v1.2.1` in multiple workflow files - Remove unnecessary blank lines in the bug report template Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2025-02-19 17:50:00 +08:00
Bo-Yi Wu	49751ff516	docs: standardize `script_file` naming to `script_path` in documentation (#360 ) - Rename `script_file` to `script_path` in README.md - Rename `script_file` to `script_path` in README.zh-cn.md - Rename `script_file` to `script_path` in README.zh-tw.md Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2025-01-03 10:17:01 +08:00
Bo-Yi Wu	86aa40ddb7	ci: add SSH server testing to GitHub Actions workflow - Add a new job `testing-script-error` to the GitHub Actions workflow - Use `actions/checkout@v4` to check out the code - Create and run a new SSH server container using `lscr.io/linuxserver/openssh-server:latest` - Capture the container's IP address and set it as an environment variable - Add a step to test script errors with `continue-on-error: true` - Configure the test script to connect to the SSH server and run a command that will fail (`ls /nonexistent`) Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2025-01-03 09:31:39 +08:00
Bo-Yi Wu	66aa4d343b	ci: add SSH testing job to GitHub Actions workflow (#355 ) * ci: add SSH testing job to GitHub Actions workflow https://github.com/appleboy/ssh-action/issues/335#issuecomment-2372414496 - Add a new job `testing-script-stop` to the GitHub Actions workflow - Set up an SSH server using a Docker container within the new job - Capture the container's IP address and store it in the GitHub environment - Add a step to run an SSH command with stdout capture - Include a script to test conditional logic within the SSH command - Add a step to check and print the captured stdout from the SSH command Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * ci: improve GitHub Actions workflow with conditional checks - Add conditional checks in GitHub Actions workflow to handle 'True' and 'False' outputs Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * ci: standardize naming and validation of stdout steps - Rename `stdout` step to `stdout01` in the GitHub Actions workflow - Rename `check stdout` step to `check stdout 01` - Update references to `stdout` to `stdout01` in echo and grep commands - Add a new step `stdout02` for SSH command execution with stdout capture - Add a new step `check stdout 02` to validate the output of `stdout02` step Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> --------- Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-12-05 16:23:32 +08:00
Jesse	102c0d2e5f	feat: capture stdout and store as output (#287 )	2024-12-04 09:49:35 +08:00
Bo-Yi Wu	e13c387332	ci(action): display an environment variable with special characters (#351 ) - Add a new job `testing07` with steps to set environment variables and create an SSH server container - Set a special character password in environment variables - Run a Docker container for an OpenSSH server and capture its IP address - Add steps to SSH into the server using username and password authentication Signed-off-by: appleboy <appleboy.tw@gmail.com>	2024-12-02 23:19:33 +08:00