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-09-10 11:39:48 +08: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
6 changed files with 105 additions and 66 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
@@ -681,3 +681,44 @@ jobs:
          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 }}