.github/workflows/main.yml

@@ -123,6 +123,22 @@ jobs:
           port: 2222
           script: whoami
 
+      - name: stop script if command error
+        uses: ./
+        continue-on-error: true
+        with:
+          host: ${{ env.REMOTE_HOST }}
+          username: linuxserver.io
+          password: password
+          key: password
+          port: 2222
+          script_stop: true
+          sync: true
+          debug: true
+          script: |
+            mkdir abc/def
+            ls -al
+
   support-key-passphrase:
     runs-on: ubuntu-latest
     steps:
@@ -199,6 +215,7 @@ jobs:
           key: ${{ env.PRIVATE_KEY }}
           port: 2222
           passphrase: 1234
+          script_stop: true
           script: |
             ls \
               -lah
@@ -275,6 +292,7 @@ jobs:
           username: linuxserver.io
           key: ${{ env.PRIVATE_KEY }}
           passphrase: 1234
+          script_stop: true
           script: |
             whoami
 
@@ -470,6 +488,7 @@ jobs:
           username: linuxserver.io
           key: ${{ env.PRIVATE_KEY }}
           port: 2222
+          script_stop: true
           request_pty: true
           command_timeout: 30s
           script: |
@@ -505,51 +524,6 @@ jobs:
           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:
@@ -585,7 +559,7 @@ jobs:
           username: linuxserver.io
           password: password
           port: 2222
-          capture_stdout: true
+          capture_stdout: 'true'
           script: |
             #!/usr/bin/env bash
             set -e

.github/workflows/stable.yml

@@ -123,6 +123,22 @@ jobs:
           port: 2222
           script: whoami
 
+      - name: stop script if command error
+        uses: appleboy/ssh-action@v1.2.0
+        continue-on-error: true
+        with:
+          host: ${{ env.REMOTE_HOST }}
+          username: linuxserver.io
+          password: password
+          key: password
+          port: 2222
+          script_stop: true
+          sync: true
+          debug: true
+          script: |
+            mkdir abc/def
+            ls -al
+
   support-key-passphrase:
     runs-on: ubuntu-latest
     steps:
@@ -199,6 +215,7 @@ jobs:
           key: ${{ env.PRIVATE_KEY }}
           port: 2222
           passphrase: 1234
+          script_stop: true
           script: |
             ls \
               -lah
@@ -275,6 +292,7 @@ jobs:
           username: linuxserver.io
           key: ${{ env.PRIVATE_KEY }}
           passphrase: 1234
+          script_stop: true
           script: |
             whoami
 
@@ -460,6 +478,7 @@ jobs:
           username: linuxserver.io
           key: ${{ env.PRIVATE_KEY }}
           port: 2222
+          script_stop: true
           request_pty: true
           command_timeout: 30s
           script: |

README.md

@@ -1,6 +1,7 @@
 # 🚀 SSH for GitHub Actions
 
-[繁體中文](./README.zh-tw.md) | [简体中文](./README.zh-cn.md)
+[繁體中文](./README.zh-tw.md)
+[简体中文](./README.zh-cn.md)
 
 [GitHub Action](https://github.com/features/actions) for executing remote SSH commands.
 
@@ -44,6 +45,7 @@ See [action.yml](./action.yml) for more detailed information.
 | 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_stop               | Stop script after first failure                                                          | false         |
 | envs                      | Pass environment variables to shell script                                               |               |
 | envs_format               | Flexible configuration of environment value transfer                                     |               |
 | debug                     | Enable debug mode                                                                        | false         |
@@ -58,18 +60,19 @@ Executing remote SSH commands.
 name: remote ssh command
 on: [push]
 jobs:
+
   build:
     name: Build
     runs-on: ubuntu-latest
     steps:
-      - name: executing remote ssh commands using password
+    - name: executing remote ssh commands using password
-        uses: appleboy/ssh-action@v1.2.0
+      uses: appleboy/ssh-action@v1.2.0
-        with:
+      with:
-          host: ${{ secrets.HOST }}
+        host: ${{ secrets.HOST }}
-          username: linuxserver.io
+        username: linuxserver.io
-          password: ${{ secrets.PASSWORD }}
+        password: ${{ secrets.PASSWORD }}
-          port: ${{ secrets.PORT }}
+        port: ${{ secrets.PORT }}
-          script: whoami
+        script: whoami
 ```
 
 output:
@@ -149,9 +152,9 @@ See the detail information about [SSH login without password](http://www.linuxpr
 
 **A note** from one of our readers: Depending on your version of SSH you might also have to do the following changes:
 
-- Put the public key in `.ssh/authorized_keys2`
+* Put the public key in `.ssh/authorized_keys2`
-- Change the permissions of `.ssh` to 700
+* Change the permissions of `.ssh` to 700
-- Change the permissions of `.ssh/authorized_keys2` to 640
+* Change the permissions of `.ssh/authorized_keys2` to 640
 
 ### If you are using OpenSSH
 
@@ -228,7 +231,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
     username: ${{ secrets.USERNAME }}
     key: ${{ secrets.KEY }}
     port: ${{ secrets.PORT }}
-    script_path: scripts/script.sh
+    script_path: scripts/script.sh 
 ```
 
 #### Multiple Hosts
@@ -303,6 +306,37 @@ The default value of `port` is `22`.
 
 _Inside `env` object, you need to pass every environment variable as a string, passing `Integer` data type or any other may output unexpected results._
 
+#### Stop script after first failure
+
+> ex: missing `abc` folder
+
+```diff
+  - name: stop script if command error
+    uses: appleboy/ssh-action@v1.2.0
+    with:
+      host: ${{ secrets.HOST }}
+      username: ${{ secrets.USERNAME }}
+      key: ${{ secrets.KEY }}
+      port: ${{ secrets.PORT }}
++     script_stop: true
+      script: |
+        mkdir abc/def
+        ls -al
+```
+
+output:
+
+```sh
+======CMD======
+mkdir abc/def
+ls -al
+
+======END======
+2019/11/21 01:16:21 Process exited with status 1
+err: mkdir: cannot create directory ‘abc/def’: No such file or directory
+##[error]Docker run failed with exit code 1
+```
+
 #### How to connect remote server using `ProxyCommand`?
 
 ```bash

README.zh-cn.md

@@ -1,54 +1,47 @@
 # 🚀 用于 GitHub Actions 的 SSH
 
-[English](./README.md) | [繁體中文](./README.zh-tw.md)
-
 [GitHub Action](https://github.com/features/actions) 用于执行远程 SSH 命令。
 
 ![ssh workflow](./images/ssh-workflow.png)
 
 [![testing main branch](https://github.com/appleboy/ssh-action/actions/workflows/main.yml/badge.svg)](https://github.com/appleboy/ssh-action/actions/workflows/main.yml)
 
-该项目使用 [Golang](https://go.dev) 和 [drone-ssh](https://github.com/appleboy/drone-ssh) 构建。🚀
-
 ## 输入变量
 
 更详细的信息，请参考 [action.yml](./action.yml)。
 
-| 输入参数                  | 描述                                                  | 默认值 |
+* `host` - SSH 主机
-| ------------------------- | ----------------------------------------------------- | ------ |
+* `port` - SSH 连接端口，默认为 `22`
-| host                      | SSH 主机地址                                          |        |
+* `username` - SSH 用户名称
-| port                      | SSH 端口号                                            | 22     |
+* `password` - SSH 密码
-| passphrase                | SSH 密钥密码短语                                      |        |
+* `passphrase` - 通常用于加密私钥的 passphrase
-| username                  | SSH 用户名                                            |        |
+* `sync` - 同步执行多个主机上的命令，默认为 false
-| password                  | SSH 密码                                              |        |
+* `timeout` - SSH 连接到远程主机的超时时间，默认为 `30s`
-| protocol                  | SSH 协议版本（tcp, tcp4, tcp6）                       | tcp    |
+* `command_timeout` - SSH 命令超时时间，默认为 10m
-| sync                      | 如果有多个主机，启用同步执行                          | false  |
+* `key` - SSH 私钥的内容，例如 ~/.ssh/id_rsa 的原始内容，请记得包含 BEGIN 和 END 行
-| use_insecure_cipher       | 使用不安全的密码算法                                  | false  |
+* `key_path` - SSH 私钥的路径
-| cipher                    | 允许的密码算法。如果未指定，则使用适当的算法          |        |
+* `fingerprint` - 主机公钥的 SHA256 指纹，默认为跳过验证
-| timeout                   | SSH 连接到主机的超时时间                              | 30s    |
+* `script` - 执行命令
-| command_timeout           | SSH 命令的超时时间                                    | 10m    |
+* `script_file` - 執行命令的文件
-| key                       | SSH 私钥的内容，例如 ~/.ssh/id_rsa 的原始内容         |        |
+* `script_stop` - 当出现第一个错误时停止执行命令
-| key_path                  | SSH 私钥的路径                                        |        |
+* `envs` - 传递环境变量到 shell script
-| fingerprint               | 主机公钥的 SHA256 指纹                                |        |
+* `debug` - 启用调试模式
-| proxy_host                | SSH 代理主机                                          |        |
+* `use_insecure_cipher` - 使用不安全的密码（ciphers）进行加密，详见 [#56](https://github.com/appleboy/ssh-action/issues/56)
-| proxy_port                | SSH 代理端口                                          | 22     |
+* `cipher` - 允许使用的密码（ciphers）算法。如果未指定，则使用适当的算法
-| proxy_protocol            | SSH 代理协议版本（tcp, tcp4, tcp6）                   | tcp    |
+
-| proxy_username            | SSH 代理用户名                                        |        |
+SSH 代理设置：
-| proxy_password            | SSH 代理密码                                          |        |
+
-| proxy_passphrase          | SSH 代理密钥密码短语                                  |        |
+* `proxy_host` - 代理主机
-| proxy_timeout             | SSH 连接到代理主机的超时时间                          | 30s    |
+* `proxy_port` - 代理端口，默认为 `22`
-| proxy_key                 | SSH 代理私钥的内容                                    |        |
+* `proxy_username` - 代理用户名
-| proxy_key_path            | SSH 代理私钥的路径                                    |        |
+* `proxy_password` - 代理密码
-| proxy_fingerprint         | 代理主机公钥的 SHA256 指纹                            |        |
+* `proxy_passphrase` - 密码通常用于加密私有密钥
-| proxy_cipher              | 代理允许的密码算法                                    |        |
+* `proxy_timeout` - SSH 连接至代理主机的超时时间，默认为 `30s`
-| proxy_use_insecure_cipher | 使用不安全的密码算法                                  | false  |
+* `proxy_key` - SSH 代理私有密钥内容
-| script                    | 执行命令                                              |        |
+* `proxy_key_path` - SSH 代理私有密钥路径
-| script_file               | 从文件执行命令                                        |        |
+* `proxy_fingerprint` - 代理主机公钥的 SHA256 指纹，默认为跳过验证
-| envs                      | 传递环境变量到 shell 脚本                             |        |
+* `proxy_use_insecure_cipher` - 使用不安全的加密方式，详见 [#56](https://github.com/appleboy/ssh-action/issues/56)
-| envs_format               | 环境变量传递的灵活配置                                |        |
+* `proxy_cipher` - 允许的加密算法。如果未指定，则使用合理的算法
-| debug                     | 启用调试模式                                          | false  |
-| allenvs                   | 将带有 `GITHUB_` 和 `INPUT_` 前缀的环境变量传递给脚本 | false  |
-| request_pty               | 请求伪终端                                            | false  |
 
 ## 使用方法
 
@@ -58,18 +51,19 @@
 name: remote ssh command
 on: [push]
 jobs:
+
   build:
     name: Build
     runs-on: ubuntu-latest
     steps:
-      - name: executing remote ssh commands using password
+    - name: executing remote ssh commands using password
-        uses: appleboy/ssh-action@v1.2.0
+      uses: appleboy/ssh-action@v1.2.0
-        with:
+      with:
-          host: ${{ secrets.HOST }}
+        host: ${{ secrets.HOST }}
-          username: ${{ secrets.USERNAME }}
+        username: ${{ secrets.USERNAME }}
-          password: ${{ secrets.PASSWORD }}
+        password: ${{ secrets.PASSWORD }}
-          port: ${{ secrets.PORT }}
+        port: ${{ secrets.PORT }}
-          script: whoami
+        script: whoami
 ```
 
 画面输出
@@ -132,9 +126,9 @@ clip < ~/.ssh/id_ed25519
 
 **来自读者的注意事项**： 根据您的 SSH 版本，您可能还需要进行以下更改：
 
-- 将公钥放在 `.ssh/authorized_keys2` 中
+* 将公钥放在 `.ssh/authorized_keys2` 中
-- 将 `.ssh` 的权限更改为 700
+* 将 `.ssh` 的权限更改为700
-- 将 `.ssh/authorized_keys2` 的权限更改为 640
+* 将 `.ssh/authorized_keys2` 的权限更改为640
 
 ### 如果你使用的是 OpenSSH
 
@@ -227,7 +221,7 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“
     username: ${{ secrets.USERNAME }}
     key: ${{ secrets.KEY }}
     port: ${{ secrets.PORT }}
-    script_path: scripts/script.sh
+    script_path: scripts/script.sh 
 ```
 
 #### 多个不同端口的主机
@@ -284,6 +278,37 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“
 
 _在 `env` 对象中，您需要将每个环境变量作为字符串传递，传递 `Integer` 数据类型或任何其他类型可能会产生意外结果。_
 
+#### 在第一次失败后停止脚本
+
+> ex: missing `abc` folder
+
+```diff
+  - name: stop script if command error
+    uses: appleboy/ssh-action@v1.2.0
+    with:
+      host: ${{ secrets.HOST }}
+      username: ${{ secrets.USERNAME }}
+      key: ${{ secrets.KEY }}
+      port: ${{ secrets.PORT }}
++     script_stop: true
+      script: |
+        mkdir abc/def
+        ls -al
+```
+
+画面输出：
+
+```sh
+======CMD======
+mkdir abc/def
+ls -al
+
+======END======
+2019/11/21 01:16:21 Process exited with status 1
+err: mkdir: cannot create directory ‘abc/def’: No such file or directory
+##[error]Docker run failed with exit code 1
+```
+
 #### 如何使用 `ProxyCommand` 连接远程服务器？
 
 ```bash
@@ -349,7 +374,7 @@ Host FooServer
 
 设置 SSH 主机指纹验证可以帮助防止中间人攻击。在设置之前，运行以下命令以获取 SSH 主机指纹。请记得将 `ed25519` 替换为您适当的密钥类型（`rsa`、 `dsa`等），而 `example.com` 则替换为您的主机。
 
-现代 OpenSSH 版本中，需要提取的**默认密钥**类型是 `rsa`（从版本 5.1 开始）、`ecdsa`（从版本 6.0 开始）和 `ed25519`（从版本 6.7 开始）。
+现代 OpenSSH 版本中，需要提取的_默认密钥_类型是 `rsa`（从版本 5.1 开始）、`ecdsa`（从版本 6.0 开始）和 `ed25519`（从版本 6.7 开始）。
 
 ```sh
 ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ’ ‘ -f2

README.zh-tw.md

@@ -1,6 +1,7 @@
 # 🚀 GitHub Actions 的 SSH
 
-[English](./README.md) | [简体中文](./README.zh-cn.md)
+[English](./README.md)
+[简体中文](./README.zh-cn.md)
 
 [GitHub Action](https://github.com/features/actions) 用於執行遠端 SSH 命令。
 
@@ -44,6 +45,7 @@
 | proxy_use_insecure_cipher | 包含更多不安全的加密算法                              | false  |
 | script                    | 執行命令                                              |        |
 | script_file               | 從文件中執行命令                                      |        |
+| script_stop               | 在第一次失敗後停止腳本                                | false  |
 | envs                      | 將環境變數傳遞給 shell 腳本                           |        |
 | envs_format               | 環境值傳遞的靈活配置                                  |        |
 | debug                     | 啟用調試模式                                          | false  |
@@ -58,18 +60,19 @@
 name: remote ssh command
 on: [push]
 jobs:
+
   build:
     name: Build
     runs-on: ubuntu-latest
     steps:
-      - name: executing remote ssh commands using password
+    - name: executing remote ssh commands using password
-        uses: appleboy/ssh-action@v1.2.0
+      uses: appleboy/ssh-action@v1.2.0
-        with:
+      with:
-          host: ${{ secrets.HOST }}
+        host: ${{ secrets.HOST }}
-          username: ${{ secrets.USERNAME }}
+        username: ${{ secrets.USERNAME }}
-          password: ${{ secrets.PASSWORD }}
+        password: ${{ secrets.PASSWORD }}
-          port: ${{ secrets.PORT }}
+        port: ${{ secrets.PORT }}
-          script: whoami
+        script: whoami
 ```
 
 畫面輸出
@@ -132,9 +135,9 @@ clip < ~/.ssh/id_ed25519
 
 **來自讀者的注意事項**： 根據您的 SSH 版本，您可能還需要進行以下更改：
 
-- 將公鑰放在 `.ssh/authorized_keys2` 中
+* 將公鑰放在 `.ssh/authorized_keys2` 中
-- 將 `.ssh` 的權限更改為 700
+* 將 `.ssh` 的權限更改為700
-- 將 `.ssh/authorized_keys2` 的權限更改為 640
+* 將 `.ssh/authorized_keys2` 的權限更改為640
 
 ### 如果你使用的是 OpenSSH
 
@@ -211,7 +214,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
     username: ${{ secrets.USERNAME }}
     key: ${{ secrets.KEY }}
     port: ${{ secrets.PORT }}
-    script_path: scripts/script.sh
+    script_path: scripts/script.sh 
 ```
 
 #### 多台主機
@@ -284,6 +287,37 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 
 _在 `env` 對象中，您需要將每個環境變量作為字符串傳遞，傳遞 `Integer` 數據類型或任何其他類型可能會產生意外結果。_
 
+#### 在第一次失敗後停止腳本
+
+> ex: missing `abc` folder
+
+```diff
+  - name: stop script if command error
+    uses: appleboy/ssh-action@v1.2.0
+    with:
+      host: ${{ secrets.HOST }}
+      username: ${{ secrets.USERNAME }}
+      key: ${{ secrets.KEY }}
+      port: ${{ secrets.PORT }}
++     script_stop: true
+      script: |
+        mkdir abc/def
+        ls -al
+```
+
+畫面輸出:
+
+```sh
+======CMD======
+mkdir abc/def
+ls -al
+
+======END======
+2019/11/21 01:16:21 Process exited with status 1
+err: mkdir: cannot create directory ‘abc/def’: No such file or directory
+##[error]Docker run failed with exit code 1
+```
+
 #### 如何使用 `ProxyCommand` 連接遠程服務器？
 
 ```bash
@@ -349,7 +383,7 @@ Host FooServer
 
 設置 SSH 主機指紋驗證可以幫助防止中間人攻擊。在設置之前，運行以下命令以獲取 SSH 主機指紋。請記得將 `ed25519` 替換為您的適當金鑰類型（`rsa`、 `dsa`等），而 `example.com` 則替換為您的主機。
 
-現代 OpenSSH 版本中，需要提取的**默認金鑰**類型是 `rsa`（從版本 5.1 開始）、`ecdsa`（從版本 6.0 開始）和 `ed25519`（從版本 6.7 開始）。
+現代 OpenSSH 版本中，需要提取的_默認金鑰_類型是 `rsa`（從版本 5.1 開始）、`ecdsa`（從版本 6.0 開始）和 `ed25519`（從版本 6.7 開始）。
 
 ```sh
 ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ' ' -f2

action.yml

@@ -65,6 +65,8 @@ inputs:
     description: "Commands to be executed."
   script_path:
     description: "Path to the file containing commands to be executed."
+  script_stop:
+    description: "Stop the script after the first failure."
   envs:
     description: "Environment variables to be passed to the shell script."
   envs_format:
@@ -120,6 +122,7 @@ runs:
         INPUT_COMMAND_TIMEOUT: ${{ inputs.command_timeout }}
         INPUT_SCRIPT: ${{ inputs.script }}
         INPUT_SCRIPT_FILE: ${{ inputs.script_path }}
+        INPUT_SCRIPT_STOP: ${{ inputs.script_stop }}
         INPUT_ENVS: ${{ inputs.envs }}
         INPUT_ENVS_FORMAT: ${{ inputs.envs_format }}
         INPUT_DEBUG: ${{ inputs.debug }}