docs(readme): set -e for script_stop functionality (#368 )

Fixes #367 Add a note in the "Input variables" section of `README.md` to mention that users can add `set -e` in their shell script to achieve similar functionality to the removed `script_stop` option. Add a note in the "输入变量" section of `README.zh-cn.md` to mention that users can add `set -e` in their shell script to achieve similar functionality to the removed `script_stop` option. Add a note in the "輸入變數" section of `README.zh-tw.md` to mention that users can add `set -e` in their shell script to achieve similar functionality to the removed `script_stop` option. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/appleboy/ssh-action/issues/367?shareId=XXXX-XXXX-XXXX-XXXX).
chore: standardize formatting and update dependencies in workflows
2026-07-12 08:15:36 +00:00 · 2025-02-24 20:31:51 +08:00 · 2025-02-19 17:50:00 +08:00
5 changed files with 67 additions and 63 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/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
@ -50,6 +50,8 @@ See [action.yml](./action.yml) for more detailed information.
 | allenvs                   | Pass the environment variables with prefix value of `GITHUB_` and `INPUT_` to the script | false         |
 | request_pty               | Request a pseudo-terminal from the server                                                | false         |

+**Note:** Users can add `set -e` in their shell script to achieve similar functionality to the removed `script_stop` option.
+
 ## Usage

 Executing remote SSH commands.
@ -63,7 +65,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 +181,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 +194,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 +207,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 +224,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 +237,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 +255,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 +270,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 +286,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 +333,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 +356,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 +382,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
@ -50,6 +50,8 @@
 | allenvs                   | 将带有 `GITHUB_` 和 `INPUT_` 前缀的环境变量传递给脚本 | false  |
 | request_pty               | 请求伪终端                                            | false  |

+**注意：** 用户可以在他们的 shell 脚本中添加 `set -e` 以实现类似于已删除的 `script_stop` 选项的功能。
+
 ## 使用方法

 执行远程 SSH 命令
@ -63,7 +65,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 +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@v1.2.0
+  uses: appleboy/ssh-action@v1.2.1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@ -175,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@v1.2.0
+  uses: appleboy/ssh-action@v1.2.1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@ -188,7 +190,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 +207,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 +223,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 +236,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 +251,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 +267,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 +314,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 +335,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 +361,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
@ -50,6 +50,8 @@
 | allenvs                   | 將帶有 `GITHUB_` 和 `INPUT_` 前綴的環境變數傳遞給腳本 | false  |
 | request_pty               | 從伺服器請求偽終端                                    | false  |

+**注意：** 用戶可以在他們的 shell 腳本中添加 `set -e` 以實現類似於已刪除的 `script_stop` 選項的功能。
+
 ## 用法

 執行遠端 SSH 命令
@ -63,7 +65,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 +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@v1.2.0
+  uses: appleboy/ssh-action@v1.2.1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@ -175,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@v1.2.0
+  uses: appleboy/ssh-action@v1.2.1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@ -188,7 +190,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 +207,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 +220,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 +236,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 +251,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 +267,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 +314,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 +335,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 +361,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 }}