Skip to content

Commit bd83ba7

Browse files
authored
docs: document and configure drone-ssh version usage (#381)
- Add `version` entry to README.md specifying drone-ssh binary version usage - Add `version` entry to README.zh-cn.md specifying drone-ssh version usage in Chinese - Add `version` entry to README.zh-tw.md specifying drone-ssh version usage in Traditional Chinese - Add `version` input to action.yml with description for drone-ssh version - Set DRONE_SSH_VERSION environment variable in action.yml to use specified version input Signed-off-by: Bo-Yi Wu <[email protected]>
1 parent 9ca1cd2 commit bd83ba7

File tree

4 files changed

+7
-0
lines changed

4 files changed

+7
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ Refer to [action.yml](./action.yml) for more detailed information.
5050
| allenvs | Pass the environment variables with prefix value of `GITHUB_` and `INPUT_` to the script | false |
5151
| request_pty | Request a pseudo-terminal from the server | false |
5252
| curl_insecure | Allow curl to connect to SSL sites without certificates | false |
53+
| version | drone-ssh binary version. If not specified, the latest version will be used. | |
5354

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

README.zh-cn.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@
5050
| allenvs | 将带有 `GITHUB_``INPUT_` 前缀的环境变量传递给脚本 | false |
5151
| request_pty | 请求伪终端 | false |
5252
| curl_insecure | 在 curl 中使用不安全的证书验证 | false |
53+
| version | drone-ssh 版本号。若未指定,将使用最新版本。 | |
5354

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

README.zh-tw.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@
5050
| allenvs | 將帶有 `GITHUB_``INPUT_` 前綴的環境變數傳遞給腳本 | false |
5151
| request_pty | 從伺服器請求偽終端 | false |
5252
| curl_insecure | 在 curl 命令中使用不安全的 SSL 證書驗證 | false |
53+
| version | drone-ssh 版本號。若未指定,將使用最新版本。 | |
5354

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

action.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,9 @@ inputs:
8181
capture_stdout:
8282
description: "When true, captures and returns standard output from the commands as action output."
8383
default: "false"
84+
version:
85+
description: |
86+
The version of drone-ssh to use.
8487
8588
outputs:
8689
stdout:
@@ -135,6 +138,7 @@ runs:
135138
INPUT_SYNC: ${{ inputs.sync }}
136139
INPUT_CAPTURE_STDOUT: ${{ inputs.capture_stdout }}
137140
INPUT_CURL_INSECURE: ${{ inputs.curl_insecure }}
141+
DRONE_SSH_VERSION: ${{ inputs.version }}
138142

139143
branding:
140144
icon: "terminal"

0 commit comments

Comments
 (0)