Skip to content

Commit

Permalink
docs(readme): set -e for script_stop functionality (#368)
Browse files Browse the repository at this point in the history
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).
  • Loading branch information
Setland34 authored Feb 24, 2025
1 parent 8faa842 commit 9817ef4
Showing 3 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 2 additions & 0 deletions README.zh-cn.md
Original file line number Diff line number Diff line change
@@ -50,6 +50,8 @@
| allenvs | 将带有 `GITHUB_``INPUT_` 前缀的环境变量传递给脚本 | false |
| request_pty | 请求伪终端 | false |

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

## 使用方法

执行远程 SSH 命令
2 changes: 2 additions & 0 deletions README.zh-tw.md
Original file line number Diff line number Diff line change
@@ -50,6 +50,8 @@
| allenvs | 將帶有 `GITHUB_``INPUT_` 前綴的環境變數傳遞給腳本 | false |
| request_pty | 從伺服器請求偽終端 | false |

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

## 用法

執行遠端 SSH 命令

0 comments on commit 9817ef4

Please sign in to comment.