chore: update action version across workflows and documentation

- Update the version of `appleboy/ssh-action` from `v1.2.1` to `v1.2.2` in multiple files - Modify the bug report template to reflect the updated action version - Change the action version in the stable workflow file - Adjust the action version in the README files for consistency across documentation - Ensure the action version is updated in both Chinese language README files Signed-off-by: appleboy <appleboy.tw@gmail.com>
docs: clarify parameter descriptions for improved documentation
2025-03-09 22:08:40 +08:00 · 2025-03-09 22:02:08 +08:00 · 2025-03-09 21:54:21 +08:00 · 2025-03-08 15:55:34 +08:00 · 2025-03-08 15:50:53 +08:00 · 2025-03-08 15:47:51 +08:00
7 changed files with 220 additions and 174 deletions
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -23,7 +23,7 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - name: executing remote ssh commands using password
-        uses: appleboy/ssh-action@v1.2.1
+        uses: appleboy/ssh-action@v1.2.2
        with:
          host: ${{ secrets.HOST }}
          username: ${{ secrets.USERNAME }}
--- 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.1
+        uses: appleboy/ssh-action@v1.2.2
        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.1
+        uses: appleboy/ssh-action@v1.2.2
        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.1
+        uses: appleboy/ssh-action@v1.2.2
        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.1
+        uses: appleboy/ssh-action@v1.2.2
        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.1
+        uses: appleboy/ssh-action@v1.2.2
        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.1
+        uses: appleboy/ssh-action@v1.2.2
        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.1
+        uses: appleboy/ssh-action@v1.2.2
        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.1
+        uses: appleboy/ssh-action@v1.2.2
        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.1
+        uses: appleboy/ssh-action@v1.2.2
        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.1
+        uses: appleboy/ssh-action@v1.2.2
        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.1
+        uses: appleboy/ssh-action@v1.2.2
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
@@ -386,7 +386,7 @@ jobs:
            ls -al

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

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

      - name: custom envs format
-        uses: appleboy/ssh-action@v1.2.1
+        uses: appleboy/ssh-action@v1.2.2
        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.1
+        uses: appleboy/ssh-action@v1.2.2
        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.1
+        uses: appleboy/ssh-action@v1.2.2
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
--- a/README.md
+++ b/README.md
@@ -1,18 +1,18 @@
 # 🚀 SSH for GitHub Actions

-[繁體中文](./README.zh-tw.md) | [简体中文](./README.zh-cn.md)
+English | [繁體中文](./README.zh-tw.md) | [简体中文](./README.zh-cn.md)

-[GitHub Action](https://github.com/features/actions) for executing remote SSH commands.
+A [GitHub Action](https://github.com/features/actions) for executing remote SSH commands.

 ![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)

-This project is built using [Golang](https://go.dev) and [drone-ssh](https://github.com/appleboy/drone-ssh). 🚀
+This project is built with [Golang](https://go.dev) and [drone-ssh](https://github.com/appleboy/drone-ssh). 🚀

 ## Input variables

-See [action.yml](./action.yml) for more detailed information.
+Refer to [action.yml](./action.yml) for more detailed information.

 | Input Parameter           | Description                                                                              | Default Value |
 | ------------------------- | ---------------------------------------------------------------------------------------- | ------------- |
@@ -22,9 +22,9 @@ See [action.yml](./action.yml) for more detailed information.
 | username                  | SSH username                                                                             |               |
 | password                  | SSH password                                                                             |               |
 | protocol                  | SSH protocol version (tcp, tcp4, tcp6)                                                   | tcp           |
-| sync                      | Enable synchronous execution if multiple hosts                                           | false         |
+| sync                      | Enable synchronous execution if multiple hosts are specified                             | false         |
 | use_insecure_cipher       | Include more ciphers with use_insecure_cipher                                            | false         |
-| cipher                    | Allowed cipher algorithms. If unspecified, a sensible default                            |               |
+| cipher                    | Allowed cipher algorithms. If unspecified, sensible defaults are used                    |               |
 | timeout                   | Timeout duration for SSH to host                                                         | 30s           |
 | command_timeout           | Timeout duration for SSH command                                                         | 10m           |
 | key                       | Content of SSH private key. e.g., raw content of ~/.ssh/id_rsa                           |               |
@@ -44,12 +44,14 @@ 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_path               | Execute commands from a file                                                             |               |
-| envs                      | Pass environment variables to shell script                                               |               |
+| envs                      | Pass environment variables to the shell script                                           |               |
 | envs_format               | Flexible configuration of environment value transfer                                     |               |
 | debug                     | Enable debug mode                                                                        | false         |
 | 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.1
+        uses: appleboy/ssh-action@v1.2.2
        with:
          host: ${{ secrets.HOST }}
          username: linuxserver.io
@@ -86,9 +88,9 @@ linuxserver.io

 ### Setting up a SSH Key

-Make sure to follow the below steps while creating SSH Keys and using them.
-The best practice is create the SSH Keys on local machine not remote machine.
-Login with username specified in Github Secrets. Generate a RSA Key-Pair:
+Follow the steps below to create and use SSH Keys.
+It is best practice to create SSH Keys on your local machine, not on a remote machine.
+Log in with the username specified in GitHub Secrets and generate an RSA Key-Pair:

 ### Generate rsa key

@@ -102,7 +104,7 @@ ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
 ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 ```

-Add newly generated key into Authorized keys. Read more about authorized keys [here](https://www.ssh.com/ssh/authorized_keys/).
+Add the newly generated key to the Authorized keys. Read more about authorized keys [here](https://www.ssh.com/ssh/authorized_keys/).

 ### Add rsa key into Authorized keys

@@ -116,18 +118,18 @@ cat .ssh/id_rsa.pub | ssh b@B 'cat >> .ssh/authorized_keys'
 cat .ssh/id_ed25519.pub | ssh b@B 'cat >> .ssh/authorized_keys'
 ```

-Copy Private Key content and paste in Github Secrets.
+Copy the Private Key content and paste it into GitHub Secrets.

 ### Copy rsa Private key

-Before copying the private key, install `clip` command as shown below:
+Before copying the private key, install the `clip` command as shown below:

 ```bash
 # Ubuntu
 sudo apt-get install xclip
 ```

-copy the private key:
+Copy the private key:

 ```bash
 # macOS
@@ -136,6 +138,8 @@ pbcopy < ~/.ssh/id_rsa
 xclip < ~/.ssh/id_rsa
 ```

+Starting from and including the comment section `-----BEGIN OPENSSH PRIVATE KEY-----` and ending at and including the comment section `-----END OPENSSH PRIVATE KEY-----`, copy the private key and paste it into GitHub Secrets.
+
 ### Copy ed25519 Private key

 ```bash
@@ -145,9 +149,9 @@ pbcopy < ~/.ssh/id_ed25519
 xclip < ~/.ssh/id_ed25519
 ```

-See the detail information about [SSH login without password](http://www.linuxproblem.org/art_9.html).
+See detailed information about [SSH login without a password](http://www.linuxproblem.org/art_9.html).

-**A note** from one of our readers: Depending on your version of SSH you might also have to do the following changes:
+**Note**: Depending on your version of SSH, you might also need to make the following changes:

 - Put the public key in `.ssh/authorized_keys2`
 - Change the permissions of `.ssh` to 700
@@ -161,13 +165,13 @@ If you are currently using OpenSSH and are getting the following error:
 ssh: handshake failed: ssh: unable to authenticate, attempted methods [none publickey]
 ```

-Make sure that your key algorithm of choice is supported. On Ubuntu 20.04 or later you must explicitly allow the use of the ssh-rsa algorithm. Add the following line to your OpenSSH daemon file (which is either `/etc/ssh/sshd_config` or a drop-in file under `/etc/ssh/sshd_config.d/`):
+Ensure that your chosen key algorithm is supported. On Ubuntu 20.04 or later, you must explicitly allow the use of the ssh-rsa algorithm. Add the following line to your OpenSSH daemon file (either `/etc/ssh/sshd_config` or a drop-in file under `/etc/ssh/sshd_config.d/`):

 ```bash
 CASignatureAlgorithms +ssh-rsa
 ```

-Alternatively, `ed25519` keys are accepted by default in OpenSSH. You could use this instead of rsa if needed:
+Alternatively, `ed25519` keys are accepted by default in OpenSSH. You can use this instead of rsa if needed:

 ```bash
 ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
@@ -179,7 +183,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.1
+  uses: appleboy/ssh-action@v1.2.2
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@@ -192,7 +196,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.1
+  uses: appleboy/ssh-action@v1.2.2
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@@ -205,7 +209,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

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

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

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

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

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

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

 ```diff
  - name: ssh proxy command
-    uses: appleboy/ssh-action@v1.2.1
+    uses: appleboy/ssh-action@v1.2.2
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
@@ -354,7 +358,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.1
+    uses: appleboy/ssh-action@v1.2.2
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
@@ -380,7 +384,7 @@ Now you can adjust you config:

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

 See the [issue comment](https://github.com/appleboy/ssh-action/issues/31#issuecomment-1006565847) about interactive vs non interactive shell. Thanks @kocyigityunus for the solution.

-Basically, if you are running a command in a non interactive shell, like ssh-action, on many linux distros,
+If you are running a command in a non-interactive shell, like ssh-action, on many Linux distros,

 `/etc/bash.bashrc` file has a specific command that returns only, so some of the files didn't run and some specific commands doesn't add to path,

@@ -413,7 +417,7 @@ Basically, if you are running a command in a non interactive shell, like ssh-act
 [ -z "$PS1" ] && return`
 ```

-just comment out the line that returns early and everything should work fine, or you can use the real paths of the commands that you would like to use.
+comment out the line that returns early, and everything should work fine. Alternatively, you can use the real paths of the commands you want to use.

 ## Contributing

--- a/README.zh-cn.md
+++ b/README.zh-cn.md
@@ -1,8 +1,8 @@
 # 🚀 用于 GitHub Actions 的 SSH

-[English](./README.md) | [繁體中文](./README.zh-tw.md)
+[English](./README.md) | [繁體中文](./README.zh-tw.md) | 简体中文

-[GitHub Action](https://github.com/features/actions) 用于执行远程 SSH 命令。
+一个用于执行远程 SSH 命令的 [GitHub Action](https://github.com/features/actions)。

 ![ssh workflow](./images/ssh-workflow.png)

@@ -12,7 +12,7 @@

 ## 输入变量

-更详细的信息，请参考 [action.yml](./action.yml)。
+有关更详细的信息，请参阅 [action.yml](./action.yml)。

 | 输入参数                  | 描述                                                  | 默认值 |
 | ------------------------- | ----------------------------------------------------- | ------ |
@@ -22,9 +22,9 @@
 | username                  | SSH 用户名                                            |        |
 | password                  | SSH 密码                                              |        |
 | protocol                  | SSH 协议版本（tcp, tcp4, tcp6）                       | tcp    |
-| sync                      | 如果有多个主机，启用同步执行                          | false  |
+| sync                      | 如果指定了多个主机，则启用同步执行                    | false  |
 | use_insecure_cipher       | 使用不安全的密码算法                                  | false  |
-| cipher                    | 允许的密码算法。如果未指定，则使用适当的算法          |        |
+| cipher                    | 允许的密码算法。如果未指定，则使用适当的默认值        |        |
 | timeout                   | SSH 连接到主机的超时时间                              | 30s    |
 | command_timeout           | SSH 命令的超时时间                                    | 10m    |
 | key                       | SSH 私钥的内容，例如 ~/.ssh/id_rsa 的原始内容         |        |
@@ -50,9 +50,11 @@
 | allenvs                   | 将带有 `GITHUB_` 和 `INPUT_` 前缀的环境变量传递给脚本 | false  |
 | request_pty               | 请求伪终端                                            | false  |

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

-执行远程 SSH 命令
+执行远程 SSH 命令。

 ```yaml
 name: remote ssh command
@@ -63,22 +65,22 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - name: executing remote ssh commands using password
-        uses: appleboy/ssh-action@v1.2.1
+        uses: appleboy/ssh-action@v1.2.2
        with:
          host: ${{ secrets.HOST }}
-          username: ${{ secrets.USERNAME }}
+          username: linuxserver.io
          password: ${{ secrets.PASSWORD }}
          port: ${{ secrets.PORT }}
          script: whoami
 ```

-画面输出
+输出：

 ```sh
 ======CMD======
 whoami
 ======END======
-out: ***
+linuxserver.io
 ===============================================
 ✅ Successfully executed commands to all hosts.
 ===============================================
@@ -86,18 +88,20 @@ out: ***

 ### 设置 SSH 密钥

-请在创建 SSH 密钥并使用 SSH 密钥时遵循以下步骤。最佳做法是在本地机器上创建 SSH 密钥而不是远程机器上。请使用 Github Secrets 中指定的用户名登录。生成 RSA 密钥：
+请按照以下步骤创建和使用 SSH 密钥。
+最佳做法是在本地机器上创建 SSH 密钥，而不是在远程机器上。
+使用 GitHub Secrets 中指定的用户名登录并生成 RSA 密钥对：

 ### 生成 RSA 密钥

 ```bash
-ssh-keygen -t rsa -b 4096 -C ”your_email@example.com“
+ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
 ```

 ### 生成 ed25519 密钥

 ```bash
-ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“
+ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 ```

 将新生成的密钥添加到已授权的密钥中。详细了解已授权的密钥请点[此处](https://www.ssh.com/ssh/authorized_keys/)。
@@ -105,32 +109,49 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“
 ### 将 RSA 密钥添加到已授权密钥中

 ```bash
-cat .ssh/id_rsa.pub | ssh b@B ’cat >> .ssh/authorized_keys‘
+cat .ssh/id_rsa.pub | ssh b@B 'cat >> .ssh/authorized_keys'
 ```

 ### 将 ed25519 密钥添加到已授权密钥中

 ```bash
-cat .ssh/id_ed25519.pub | ssh b@B ’cat >> .ssh/authorized_keys‘
+cat .ssh/id_ed25519.pub | ssh b@B 'cat >> .ssh/authorized_keys'
 ```

-复制私钥内容，然后将其粘贴到 Github Secrets 中。
+复制私钥内容，然后将其粘贴到 GitHub Secrets 中。

-### 复制 rsa 私钥内容
+### 复制 RSA 私钥内容
+
+在复制私钥之前，按照以下步骤安装 `clip` 命令：

 ```bash
-clip < ~/.ssh/id_rsa
+# Ubuntu
+sudo apt-get install xclip
 ```

+复制私钥：
+
+```bash
+# macOS
+pbcopy < ~/.ssh/id_rsa
+# Ubuntu
+xclip < ~/.ssh/id_rsa
+```
+
+从包含注释部分 `-----BEGIN OPENSSH PRIVATE KEY-----` 开始，到包含注释部分 `-----END OPENSSH PRIVATE KEY-----` 结束，复制私钥并将其粘贴到 GitHub Secrets 中。
+
 ### 复制 ed25519 私钥内容

 ```bash
-clip < ~/.ssh/id_ed25519
+# macOS
+pbcopy < ~/.ssh/id_ed25519
+# Ubuntu
+xclip < ~/.ssh/id_ed25519
 ```

 有关无需密码登录 SSH 的详细信息，请[见该网站](http://www.linuxproblem.org/art_9.html)。

-**来自读者的注意事项**： 根据您的 SSH 版本，您可能还需要进行以下更改：
+**注意**：根据您的 SSH 版本，您可能还需要进行以下更改：

 - 将公钥放在 `.ssh/authorized_keys2` 中
 - 将 `.ssh` 的权限更改为 700
@@ -144,25 +165,25 @@ clip < ~/.ssh/id_ed25519
 ssh: handshake failed: ssh: unable to authenticate, attempted methods [none publickey]
 ```

-请确保您所选择的密钥算法得到支持。在 Ubuntu 20.04 或更高版本上，您必须明确允许使用 SSH-RSA 算法。请在 OpenSSH 守护进程文件中添加以下行（它可以是 `/etc/ssh/sshd_config` 或 `/etc/ssh/sshd_config.d/` 中的一个附加文件）：
+请确保您所选择的密钥算法得到支持。在 Ubuntu 20.04 或更高版本上，您必须明确允许使用 ssh-rsa 算法。请在 OpenSSH 守护进程文件中添加以下行（它可以是 `/etc/ssh/sshd_config` 或 `/etc/ssh/sshd_config.d/` 中的一个附加文件）：

 ```bash
 CASignatureAlgorithms +ssh-rsa
 ```

-或者，`Ed25519` 密钥在 OpenSSH 中默认被接受。如果需要，您可以使用它来替代 RSA。
+或者，`ed25519` 密钥在 OpenSSH 中默认被接受。如果需要，您可以使用它来替代 RSA：

 ```bash
-ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“
+ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 ```

-### Example
+### 示例

 #### 使用密码执行远程 SSH 命令

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

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

 ![result](./images/output-result.png)

-#### 多台主机
-
-```diff
-  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.1
-    with:
-     host: ”foo.com“
-+     host: ”foo.com,bar.com“
-      username: ${{ secrets.USERNAME }}
-      key: ${{ secrets.KEY }}
-      port: ${{ secrets.PORT }}
-      script: |
-        whoami
-        ls -al
-```
-
-#### Commands from a file
+#### 从文件执行命令

 ```yaml
 - name: file commands
-  uses: appleboy/ssh-action@v1.2.1
+  uses: appleboy/ssh-action@v1.2.2
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@@ -230,14 +235,32 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“
    script_path: scripts/script.sh
 ```

+#### 多台主机
+
+```diff
+  - name: multiple host
+    uses: appleboy/ssh-action@v1.2.2
+    with:
+-     host: "foo.com"
+     host: "foo.com,bar.com"
+      username: ${{ secrets.USERNAME }}
+      key: ${{ secrets.KEY }}
+      port: ${{ secrets.PORT }}
+      script: |
+        whoami
+        ls -al
+```
+
+默认的 `port` 值是 `22`。
+
 #### 多个不同端口的主机

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.1
+    uses: appleboy/ssh-action@v1.2.2
    with:
-     host: ”foo.com“
-+     host: ”foo.com:1234,bar.com:5678“
+-     host: "foo.com"
+     host: "foo.com:1234,bar.com:5678"
      username: ${{ secrets.USERNAME }}
      key: ${{ secrets.KEY }}
      script: |
@@ -249,9 +272,9 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.1
+    uses: appleboy/ssh-action@v1.2.2
    with:
-      host: ”foo.com,bar.com“
+      host: "foo.com,bar.com"
 +     sync: true
      username: ${{ secrets.USERNAME }}
      key: ${{ secrets.KEY }}
@@ -261,14 +284,14 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“
        ls -al
 ```

-#### 将环境变量传递到 Shell 脚本
+#### 将环境变量传递到 shell 脚本

 ```diff
  - name: pass environment
-    uses: appleboy/ssh-action@v1.2.1
+    uses: appleboy/ssh-action@v1.2.2
 +   env:
-+     FOO: ”BAR“
-+     BAR: ”FOO“
+     FOO: "BAR"
+     BAR: "FOO"
 +     SHA: ${{ github.sha }}
    with:
      host: ${{ secrets.HOST }}
@@ -277,9 +300,9 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“
      port: ${{ secrets.PORT }}
 +     envs: FOO,BAR,SHA
      script: |
-        echo ”I am $FOO“
-        echo ”I am $BAR“
-        echo ”sha: $SHA“
+        echo "I am $FOO"
+        echo "I am $BAR"
+        echo "sha: $SHA"
 ```

 _在 `env` 对象中，您需要将每个环境变量作为字符串传递，传递 `Integer` 数据类型或任何其他类型可能会产生意外结果。_
@@ -287,9 +310,9 @@ _在 `env` 对象中，您需要将每个环境变量作为字符串传递，传
 #### 如何使用 `ProxyCommand` 连接远程服务器？

 ```bash
-+———+       +-———+      +————+
-| Laptop | <—>  | Jumphost | <—> | FooServer |
-+———+       +-———+      +————+
+--------+       +----------+      +-----------+
+| Laptop | <-->  | Jumphost | <--> | FooServer |
+--------+       +----------+      +-----------+
 ```

 在您的 `~/.ssh/config` 文件中，您会看到以下内容。
@@ -312,7 +335,7 @@ Host FooServer

 ```diff
  - name: ssh proxy command
-    uses: appleboy/ssh-action@v1.2.1
+    uses: appleboy/ssh-action@v1.2.2
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
@@ -327,13 +350,13 @@ Host FooServer
        ls -al
 ```

-#### 如何保护私钥？
+#### 保护私钥

-密码短语通常用于加密私钥。这使得攻击者无法单独使用密钥文件。文件泄露可能来自备份或停用的硬件，黑客通常可以从受攻击系统中泄露文件。因此，保护私钥非常重要。
+密码短语通常用于加密私钥。这使得密钥文件本身对攻击者无用。文件泄露可能来自备份或停用的硬件，黑客通常可以从受攻击系统中泄露文件。

 ```diff
  - name: ssh key passphrase
-    uses: appleboy/ssh-action@v1.2.1
+    uses: appleboy/ssh-action@v1.2.2
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
@@ -349,17 +372,17 @@ 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
+ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ' ' -f2
 ```

 现在您可以调整您的配置：

 ```diff
  - name: ssh key passphrase
-    uses: appleboy/ssh-action@v1.2.1
+    uses: appleboy/ssh-action@v1.2.2
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
@@ -377,4 +400,4 @@ ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ’

 ## 授权方式

-本项目中的脚本和文档采用 [MIT](LICENSE) 许可证 发布。
+本项目中的脚本和文档采用 [MIT 许可证](LICENSE) 发布。
--- a/README.zh-tw.md
+++ b/README.zh-tw.md
@@ -1,6 +1,6 @@
 # 🚀 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 命令。

@@ -50,6 +50,8 @@
 | allenvs                   | 將帶有 `GITHUB_` 和 `INPUT_` 前綴的環境變數傳遞給腳本 | false  |
 | request_pty               | 從伺服器請求偽終端                                    | false  |

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

 執行遠端 SSH 命令
@@ -63,10 +65,10 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - name: executing remote ssh commands using password
-        uses: appleboy/ssh-action@v1.2.1
+        uses: appleboy/ssh-action@v1.2.2
        with:
          host: ${{ secrets.HOST }}
-          username: ${{ secrets.USERNAME }}
+          username: linuxserver.io
          password: ${{ secrets.PASSWORD }}
          port: ${{ secrets.PORT }}
          script: whoami
@@ -78,7 +80,7 @@ jobs:
 ======CMD======
 whoami
 ======END======
-out: ***
+linuxserver.io
 ===============================================
 ✅ Successfully executed commands to all hosts.
 ===============================================
@@ -118,19 +120,36 @@ cat .ssh/id_ed25519.pub | ssh b@B 'cat >> .ssh/authorized_keys'

 ### 複製 rsa 私鑰內容

+在複製私鑰之前，請按照以下說明安裝 `clip` 命令：
+
 ```bash
-clip < ~/.ssh/id_rsa
+# Ubuntu
+sudo apt-get install xclip
 ```

+複製私鑰：
+
+```bash
+# macOS
+pbcopy < ~/.ssh/id_rsa
+# Ubuntu
+xclip < ~/.ssh/id_rsa
+```
+
+從包含註釋部分 `-----BEGIN OPENSSH PRIVATE KEY-----` 開始，到包含註釋部分 `-----END OPENSSH PRIVATE KEY-----` 結束，複製私鑰並將其粘貼到 GitHub Secrets 中。
+
 ### 複製 ed25519 私鑰內容

 ```bash
-clip < ~/.ssh/id_ed25519
+# macOS
+pbcopy < ~/.ssh/id_ed25519
+# Ubuntu
+xclip < ~/.ssh/id_ed25519
 ```

 有關無需密碼登錄 SSH 的詳細信息，請[參見該網站](http://www.linuxproblem.org/art_9.html)。

-**來自讀者的注意事項**： 根據您的 SSH 版本，您可能還需要進行以下更改：
+**注意**：根據您的 SSH 版本，您可能還需要進行以下更改：

 - 將公鑰放在 `.ssh/authorized_keys2` 中
 - 將 `.ssh` 的權限更改為 700
@@ -162,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.1
+  uses: appleboy/ssh-action@v1.2.2
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@@ -175,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.1
+  uses: appleboy/ssh-action@v1.2.2
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@@ -188,7 +207,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

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

 ![result](./images/output-result.png)

-#### Commands from a file
+#### 從文件中執行命令

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

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

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

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

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

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

 ```diff
  - name: ssh key passphrase
-    uses: appleboy/ssh-action@v1.2.1
+    uses: appleboy/ssh-action@v1.2.2
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
@@ -359,7 +378,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.1
+    uses: appleboy/ssh-action@v1.2.2
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
--- a/action.yml
+++ b/action.yml
@@ -3,85 +3,85 @@ description: "Executing remote ssh commands"
 author: "Bo-Yi Wu"
 inputs:
  host:
-    description: "SSH host address."
+    description: "SSH host address or IP to connect to."
  port:
-    description: "SSH port number."
+    description: "SSH port number for the connection."
    default: "22"
  passphrase:
-    description: "Passphrase for the SSH key."
+    description: "Passphrase to decrypt the SSH private key if protected."
  username:
-    description: "SSH username."
+    description: "SSH username for authentication on the remote server."
  password:
-    description: "SSH password."
+    description: "SSH password for authentication (use secrets for sensitive data)."
  protocol:
-    description: 'The IP protocol to use. Valid values are "tcp". "tcp4" or "tcp6". Default to tcp.'
+    description: 'IP protocol version to use. Options: "tcp" (default), "tcp4" (IPv4 only), or "tcp6" (IPv6 only).'
    default: "tcp"
  sync:
-    description: "Enable synchronous execution if multiple hosts are involved."
+    description: "When true, executes commands synchronously across multiple hosts (one after another)."
  use_insecure_cipher:
-    description: "Include more ciphers by using insecure ciphers."
+    description: "Enable additional legacy ciphers that might be less secure but more compatible with older systems."
  cipher:
-    description: "Allowed cipher algorithms. If unspecified, a sensible default is used."
+    description: "Specify custom cipher algorithms for encryption. Leave empty to use secure defaults."
  timeout:
-    description: "Timeout duration for establishing SSH connection to the host."
+    description: "Maximum time to wait when establishing the SSH connection, e.g., '30s', '1m'."
    default: "30s"
  command_timeout:
-    description: "Timeout duration for SSH commands execution."
+    description: "Maximum execution time for the remote commands before terminating, e.g., '10m', '1h'."
    default: "10m"
  key:
-    description: "Content of the SSH private key. For example, the raw content of ~/.ssh/id_rsa."
+    description: "Raw content of the SSH private key for authentication (use secrets for sensitive data)."
  key_path:
-    description: "Path to the SSH private key file."
+    description: "Path to the SSH private key file on the runner."
  fingerprint:
-    description: "SHA256 fingerprint of the host public key."
+    description: "SHA256 fingerprint of the host public key for verification to prevent MITM attacks."
  proxy_host:
-    description: "SSH proxy host address."
+    description: "Proxy server hostname or IP if connecting through an SSH jump host."
  proxy_port:
-    description: "SSH proxy port number."
+    description: "SSH port number for the proxy connection."
    default: "22"
  proxy_username:
-    description: "SSH proxy username."
+    description: "Username for authentication on the proxy server."
  proxy_password:
-    description: "SSH proxy password."
+    description: "Password for authentication on the proxy server (use secrets for sensitive data)."
  proxy_protocol:
-    description: 'The IP protocol to use. Valid values are "tcp". "tcp4" or "tcp6". Default to tcp.'
+    description: 'IP protocol version for proxy. Options: "tcp" (default), "tcp4" (IPv4 only), or "tcp6" (IPv6 only).'
    default: "tcp"
  proxy_passphrase:
-    description: "SSH proxy key passphrase."
+    description: "Passphrase to decrypt the proxy SSH private key if protected."
  proxy_timeout:
-    description: "Timeout duration for establishing SSH connection to the proxy host."
+    description: "Maximum time to wait when establishing the proxy SSH connection, e.g., '30s', '1m'."
    default: "30s"
  proxy_key:
-    description: "Content of the SSH proxy private key. For example, the raw content of ~/.ssh/id_rsa."
+    description: "Raw content of the SSH proxy private key for authentication (use secrets for sensitive data)."
  proxy_key_path:
-    description: "Path to the SSH proxy private key file."
+    description: "Path to the SSH proxy private key file on the runner."
  proxy_fingerprint:
-    description: "SHA256 fingerprint of the proxy host public key."
+    description: "SHA256 fingerprint of the proxy host public key for verification."
  proxy_cipher:
-    description: "Allowed cipher algorithms for the proxy. If unspecified, a sensible default is used."
+    description: "Specify custom cipher algorithms for proxy connection encryption."
  proxy_use_insecure_cipher:
-    description: "Include more ciphers for the proxy by using insecure ciphers."
+    description: "Enable additional legacy ciphers for proxy connections (less secure but more compatible)."
  script:
-    description: "Commands to be executed."
+    description: "Commands to execute on the remote server (inline script string)."
  script_path:
-    description: "Path to the file containing commands to be executed."
+    description: "Path to a local file containing commands to execute on the remote server."
  envs:
-    description: "Environment variables to be passed to the shell script."
+    description: "Environment variables to expose to the remote script, format: key=value,key2=value2."
  envs_format:
-    description: "Flexible configuration for environment value transfer."
+    description: "Format specification for environment variable transfer (for advanced usage)."
  debug:
-    description: "Enable debug mode."
+    description: "Set to true to enable verbose logging for troubleshooting connection issues."
  allenvs:
-    description: "pass all environment variable to shell script."
+    description: "When true, passes all GitHub Actions environment variables to the remote script."
  request_pty:
-    description: "Request a pseudo-terminal from the server."
+    description: "Request a pseudo-terminal from the server (required for interactive commands or sudo)."
  capture_stdout:
-    description: "Capture the stdout of the commands."
+    description: "When true, captures and returns standard output from the commands as action output."
    default: "false"

 outputs:
  stdout:
-    description: 'Standard output of the executed commands.'
+    description: "Standard output of the executed commands when capture_stdout is enabled."
    value: ${{ steps.entrypoint.outputs.stdout }}

 runs:
--- a/entrypoint.sh
+++ b/entrypoint.sh
@@ -8,7 +8,7 @@ export GITHUB="true"

 GITHUB_ACTION_PATH="${GITHUB_ACTION_PATH%/}"
 DRONE_SSH_RELEASE_URL="${DRONE_SSH_RELEASE_URL:-https://github.com/appleboy/drone-ssh/releases/download}"
-DRONE_SSH_VERSION="${DRONE_SSH_VERSION:-1.8.0}"
+DRONE_SSH_VERSION="${DRONE_SSH_VERSION:-1.8.1}"

 function detect_client_info() {
  if [ -n "${SSH_CLIENT_OS-}" ]; then
@@ -69,9 +69,9 @@ echo "======= CLI Version ======="
 sh -c "${TARGET} --version" # print version
 echo "==========================="
 if [[ "$INPUT_CAPTURE_STDOUT" == 'true' ]]; then
-  echo 'stdout<<EOF' >> $GITHUB_OUTPUT # use heredoc for multiline output
+  echo 'stdout<<EOF' >>$GITHUB_OUTPUT          # use heredoc for multiline output
  sh -c "${TARGET} $*" | tee -a $GITHUB_OUTPUT # run the command
-  echo 'EOF' >> $GITHUB_OUTPUT
+  echo 'EOF' >>$GITHUB_OUTPUT
 else
  sh -c "${TARGET} $*" # run the command
 fi
Author	SHA1	Message	Date
appleboy	2ead5e3657	chore: update action version across workflows and documentation Some checks failed testing stable version / default-user-name-password (push) Has been cancelled testing stable version / check-ssh-key (push) Has been cancelled testing stable version / support-key-passphrase (push) Has been cancelled testing stable version / multiple-server (push) Has been cancelled testing stable version / support-ed25519-key (push) Has been cancelled testing stable version / testing-with-env (push) Has been cancelled testing main branch / default-user-name-password (push) Has been cancelled testing main branch / check-ssh-key (push) Has been cancelled testing main branch / support-key-passphrase (push) Has been cancelled testing main branch / multiple-server (push) Has been cancelled testing main branch / support-ed25519-key (push) Has been cancelled testing main branch / testing-with-env (push) Has been cancelled testing main branch / testing ipv6 (push) Has been cancelled testing main branch / some special character (push) Has been cancelled testing main branch / testing-capturing-output (push) Has been cancelled testing main branch / testing-script-stop (push) Has been cancelled testing main branch / testing-script-error (push) Has been cancelled Goreleaser / goreleaser (push) Has been cancelled - Update the version of `appleboy/ssh-action` from `v1.2.1` to `v1.2.2` in multiple files - Modify the bug report template to reflect the updated action version - Change the action version in the stable workflow file - Adjust the action version in the README files for consistency across documentation - Ensure the action version is updated in both Chinese language README files Signed-off-by: appleboy <appleboy.tw@gmail.com>	2025-03-09 22:08:40 +08:00
appleboy	a0a0326939	docs: clarify parameter descriptions for improved documentation - Update descriptions for various input parameters to provide clearer guidance on their usage. - Enhance the description for the `capture_stdout` parameter to specify its effect on action output. - Modify the description for the `stdout` output to clarify its relation to the `capture_stdout` setting. Signed-off-by: appleboy <appleboy.tw@gmail.com>	2025-03-09 22:02:08 +08:00
appleboy	b0a8f324e1	chore: bump DRONE_SSH version to 1.8.1 - Update the default version of DRONE_SSH from 1.8.0 to 1.8.1 Signed-off-by: appleboy <appleboy.tw@gmail.com>	2025-03-09 21:54:21 +08:00
appleboy	039c9e07bb	docs: update README with private key instructions in multiple languages - Add instructions for copying the private key to GitHub Secrets in English, Chinese (Simplified), and Chinese (Traditional) versions of the README. ref: https://github.com/appleboy/ssh-action/issues/6#issuecomment-922368411 Signed-off-by: appleboy <appleboy.tw@gmail.com>	2025-03-08 15:55:34 +08:00
appleboy	48992f2e2c	docs: prioritize English in language selection options - Change the language options to include English as the first option. Signed-off-by: appleboy <appleboy.tw@gmail.com>	2025-03-08 15:50:53 +08:00
appleboy	01a53594eb	docs: enhance language support and improve documentation clarity - Add Simplified Chinese as an option in the language selection - Improve the phrasing of sentences for clarity in the GitHub Action description - Update instructions for enabling synchronous execution for multiple hosts - Clarify the default behavior for the cipher option - Change the wording for SSH command execution to enhance readability - Update the username in the example to a specific value - Revise instructions for copying SSH keys to include installation steps for the `clip` command - Adjust the phrasing for security practices regarding private key protection - Update the license statement to specify the MIT license more clearly - Change section titles for better consistency and clarity across languages Signed-off-by: appleboy <appleboy.tw@gmail.com>	2025-03-08 15:47:51 +08:00
appleboy	d99ccf8c09	docs: improve documentation clarity and consistency - Change "GitHub Action" to "A GitHub Action" for clarity. - Update phrasing from "built using" to "built with" for consistency. - Revise "Make sure to follow the below steps" to "Follow the steps below" for improved readability. - Modify "best practice is create" to "It is best practice to create" for grammatical correctness. - Change "Add newly generated key into Authorized keys" to "Add the newly generated key to the Authorized keys" for clarity. - Update "Copy Private Key content and paste in Github Secrets" to "Copy the Private Key content and paste it into GitHub Secrets" for consistency. - Change "install `clip` command" to "install the `clip` command" for grammatical correctness. - Revise "See the detail information about" to "See detailed information about" for improved readability. - Update "A note from one of our readers" to "Note: Depending on your version of SSH" for clarity. - Change "Make sure that your key algorithm of choice is supported" to "Ensure that your chosen key algorithm is supported" for conciseness. - Revise "Alternatively, `ed25519` keys are accepted by default" to "Alternatively, `ed25519` keys are accepted by default in OpenSSH" for clarity. - Update "if you are running a command in a non interactive shell" to "If you are running a command in a non-interactive shell" for grammatical correctness. Signed-off-by: appleboy <appleboy.tw@gmail.com>	2025-03-08 15:42:40 +08:00
Bo-Yi Wu	92737056c0	docs: improve documentation and defaults for execution and security - Clarify that synchronous execution is enabled if multiple hosts are specified - Specify that sensible defaults are used for allowed cipher algorithms if unspecified - Clarify that environment variables are passed to the shell script Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2025-03-07 08:10:39 +08:00
Seth Landry	9817ef4a17	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).	2025-02-24 20:31:51 +08:00