Skip to content

Commit 7eaf766

Browse files
appleboyappleboy
committed
docs(readme): update SSH action and enhance Chinese README files
- Update `appleboy/ssh-action` from version `v1.1.0` to `v1.2.0` in multiple instances - Add `script_file` option to the Chinese (Simplified) and Chinese (Traditional) README files - Add example for executing commands from a file in the Chinese (Simplified) and Chinese (Traditional) README files Signed-off-by: appleboy <appleboy.tw@gmail.com>
1 parent 176437b commit 7eaf766

File tree

3 files changed

+65
-37
lines changed

3 files changed

+65
-37
lines changed

‎README.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ jobs:
6868
runs-on: ubuntu-latest
6969
steps:
7070
- name: executing remote ssh commands using password
71-
uses: appleboy/ssh-action@v1.1.0
71+
uses: appleboy/ssh-action@v1.2.0
7272
with:
7373
host: ${{ secrets.HOST }}
7474
username: linuxserver.io
@@ -184,7 +184,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
184184

185185
```yaml
186186
- name: executing remote ssh commands using password
187-
uses: appleboy/ssh-action@v1.1.0
187+
uses: appleboy/ssh-action@v1.2.0
188188
with:
189189
host: ${{ secrets.HOST }}
190190
username: ${{ secrets.USERNAME }}
@@ -197,7 +197,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
197197
198198
```yaml
199199
- name: executing remote ssh commands using ssh key
200-
uses: appleboy/ssh-action@v1.1.0
200+
uses: appleboy/ssh-action@v1.2.0
201201
with:
202202
host: ${{ secrets.HOST }}
203203
username: ${{ secrets.USERNAME }}
@@ -210,7 +210,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
210210
211211
```yaml
212212
- name: multiple command
213-
uses: appleboy/ssh-action@v1.1.0
213+
uses: appleboy/ssh-action@v1.2.0
214214
with:
215215
host: ${{ secrets.HOST }}
216216
username: ${{ secrets.USERNAME }}
@@ -227,7 +227,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
227227
228228
```yaml
229229
- name: file commands
230-
uses: appleboy/ssh-action@v1.1.0
230+
uses: appleboy/ssh-action@v1.2.0
231231
with:
232232
host: ${{ secrets.HOST }}
233233
username: ${{ secrets.USERNAME }}
@@ -240,7 +240,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
240240
241241
```diff
242242
- name: multiple host
243-
uses: appleboy/ssh-action@v1.1.0
243+
uses: appleboy/ssh-action@v1.2.0
244244
with:
245245
- host: "foo.com"
246246
+ host: "foo.com,bar.com"
@@ -258,7 +258,7 @@ The default value of `port` is `22`.
258258

259259
```diff
260260
- name: multiple host
261-
uses: appleboy/ssh-action@v1.1.0
261+
uses: appleboy/ssh-action@v1.2.0
262262
with:
263263
- host: "foo.com"
264264
+ host: "foo.com:1234,bar.com:5678"
@@ -273,7 +273,7 @@ The default value of `port` is `22`.
273273

274274
```diff
275275
- name: multiple host
276-
uses: appleboy/ssh-action@v1.1.0
276+
uses: appleboy/ssh-action@v1.2.0
277277
with:
278278
host: "foo.com,bar.com"
279279
+ sync: true
@@ -289,7 +289,7 @@ The default value of `port` is `22`.
289289

290290
```diff
291291
- name: pass environment
292-
uses: appleboy/ssh-action@v1.1.0
292+
uses: appleboy/ssh-action@v1.2.0
293293
+ env:
294294
+ FOO: "BAR"
295295
+ BAR: "FOO"
@@ -314,7 +314,7 @@ _Inside `env` object, you need to pass every environment variable as a string, p
314314

315315
```diff
316316
- name: stop script if command error
317-
uses: appleboy/ssh-action@v1.1.0
317+
uses: appleboy/ssh-action@v1.2.0
318318
with:
319319
host: ${{ secrets.HOST }}
320320
username: ${{ secrets.USERNAME }}
@@ -367,7 +367,7 @@ Host FooServer
367367

368368
```diff
369369
- name: ssh proxy command
370-
uses: appleboy/ssh-action@v1.1.0
370+
uses: appleboy/ssh-action@v1.2.0
371371
with:
372372
host: ${{ secrets.HOST }}
373373
username: ${{ secrets.USERNAME }}
@@ -390,7 +390,7 @@ It is not uncommon for files to leak from backups or decommissioned hardware, an
390390

391391
```diff
392392
- name: ssh key passphrase
393-
uses: appleboy/ssh-action@v1.1.0
393+
uses: appleboy/ssh-action@v1.2.0
394394
with:
395395
host: ${{ secrets.HOST }}
396396
username: ${{ secrets.USERNAME }}
@@ -416,7 +416,7 @@ Now you can adjust you config:
416416

417417
```diff
418418
- name: ssh key passphrase
419-
uses: appleboy/ssh-action@v1.1.0
419+
uses: appleboy/ssh-action@v1.2.0
420420
with:
421421
host: ${{ secrets.HOST }}
422422
username: ${{ secrets.USERNAME }}

‎README.zh-cn.md‎

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
* `key_path` - SSH 私钥的路径
2525
* `fingerprint` - 主机公钥的 SHA256 指纹，默认为跳过验证
2626
* `script` - 执行命令
27+
* `script_file` - 執行命令的文件
2728
* `script_stop` - 当出现第一个错误时停止执行命令
2829
* `envs` - 传递环境变量到 shell script
2930
* `debug` - 启用调试模式
@@ -58,7 +59,7 @@ jobs:
5859
runs-on: ubuntu-latest
5960
steps:
6061
- name: executing remote ssh commands using password
61-
uses: appleboy/ssh-action@v1.1.0
62+
uses: appleboy/ssh-action@v1.2.0
6263
with:
6364
host: ${{ secrets.HOST }}
6465
username: ${{ secrets.USERNAME }}
@@ -157,7 +158,7 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“
157158

158159
```yaml
159160
- name: executing remote ssh commands using password
160-
uses: appleboy/ssh-action@v1.1.0
161+
uses: appleboy/ssh-action@v1.2.0
161162
with:
162163
host: ${{ secrets.HOST }}
163164
username: ${{ secrets.USERNAME }}
@@ -170,7 +171,7 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“
170171
171172
```yaml
172173
- name: executing remote ssh commands using ssh key
173-
uses: appleboy/ssh-action@v1.1.0
174+
uses: appleboy/ssh-action@v1.2.0
174175
with:
175176
host: ${{ secrets.HOST }}
176177
username: ${{ secrets.USERNAME }}
@@ -183,7 +184,7 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“
183184
184185
```yaml
185186
- name: multiple command
186-
uses: appleboy/ssh-action@v1.1.0
187+
uses: appleboy/ssh-action@v1.2.0
187188
with:
188189
host: ${{ secrets.HOST }}
189190
username: ${{ secrets.USERNAME }}
@@ -200,7 +201,7 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“
200201
201202
```diff
202203
- name: multiple host
203-
uses: appleboy/ssh-action@v1.1.0
204+
uses: appleboy/ssh-action@v1.2.0
204205
with:
205206
- host: ”foo.com“
206207
+ host: ”foo.com,bar.com“
@@ -212,11 +213,24 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“
212213
ls -al
213214
```
214215
216+
#### Commands from a file
217+
218+
```yaml
219+
- name: file commands
220+
uses: appleboy/ssh-action@v1.2.0
221+
with:
222+
host: ${{ secrets.HOST }}
223+
username: ${{ secrets.USERNAME }}
224+
key: ${{ secrets.KEY }}
225+
port: ${{ secrets.PORT }}
226+
script_path: scripts/script.sh
227+
```
228+
215229
#### 多个不同端口的主机
216230
217231
```diff
218232
- name: multiple host
219-
uses: appleboy/ssh-action@v1.1.0
233+
uses: appleboy/ssh-action@v1.2.0
220234
with:
221235
- host: ”foo.com“
222236
+ host: ”foo.com:1234,bar.com:5678“
@@ -231,7 +245,7 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“
231245
232246
```diff
233247
- name: multiple host
234-
uses: appleboy/ssh-action@v1.1.0
248+
uses: appleboy/ssh-action@v1.2.0
235249
with:
236250
host: ”foo.com,bar.com“
237251
+ sync: true
@@ -247,7 +261,7 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“
247261
248262
```diff
249263
- name: pass environment
250-
uses: appleboy/ssh-action@v1.1.0
264+
uses: appleboy/ssh-action@v1.2.0
251265
+ env:
252266
+ FOO: ”BAR“
253267
+ BAR: ”FOO“
@@ -272,7 +286,7 @@ _在 `env` 对象中，您需要将每个环境变量作为字符串传递，传
272286

273287
```diff
274288
- name: stop script if command error
275-
uses: appleboy/ssh-action@v1.1.0
289+
uses: appleboy/ssh-action@v1.2.0
276290
with:
277291
host: ${{ secrets.HOST }}
278292
username: ${{ secrets.USERNAME }}
@@ -325,7 +339,7 @@ Host FooServer
325339

326340
```diff
327341
- name: ssh proxy command
328-
uses: appleboy/ssh-action@v1.1.0
342+
uses: appleboy/ssh-action@v1.2.0
329343
with:
330344
host: ${{ secrets.HOST }}
331345
username: ${{ secrets.USERNAME }}
@@ -346,7 +360,7 @@ Host FooServer
346360

347361
```diff
348362
- name: ssh key passphrase
349-
uses: appleboy/ssh-action@v1.1.0
363+
uses: appleboy/ssh-action@v1.2.0
350364
with:
351365
host: ${{ secrets.HOST }}
352366
username: ${{ secrets.USERNAME }}
@@ -372,7 +386,7 @@ ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ’
372386

373387
```diff
374388
- name: ssh key passphrase
375-
uses: appleboy/ssh-action@v1.1.0
389+
uses: appleboy/ssh-action@v1.2.0
376390
with:
377391
host: ${{ secrets.HOST }}
378392
username: ${{ secrets.USERNAME }}

‎README.zh-tw.md‎

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
* `key_path` - SSH 私鑰的路徑
2525
* `fingerprint` - 主機公鑰的 SHA256 指紋，預設為略過驗證
2626
* `script` - 執行命令
27+
* `script_file` - 執行命令的文件
2728
* `script_stop` - 當出現第一個錯誤時停止執行命令
2829
* `envs` - 傳遞環境變數到 shell script
2930
* `debug` - 啟用偵錯模式
@@ -58,7 +59,7 @@ jobs:
5859
runs-on: ubuntu-latest
5960
steps:
6061
- name: executing remote ssh commands using password
61-
uses: appleboy/ssh-action@v1.1.0
62+
uses: appleboy/ssh-action@v1.2.0
6263
with:
6364
host: ${{ secrets.HOST }}
6465
username: ${{ secrets.USERNAME }}
@@ -157,7 +158,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
157158

158159
```yaml
159160
- name: executing remote ssh commands using password
160-
uses: appleboy/ssh-action@v1.1.0
161+
uses: appleboy/ssh-action@v1.2.0
161162
with:
162163
host: ${{ secrets.HOST }}
163164
username: ${{ secrets.USERNAME }}
@@ -170,7 +171,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
170171
171172
```yaml
172173
- name: executing remote ssh commands using ssh key
173-
uses: appleboy/ssh-action@v1.1.0
174+
uses: appleboy/ssh-action@v1.2.0
174175
with:
175176
host: ${{ secrets.HOST }}
176177
username: ${{ secrets.USERNAME }}
@@ -183,7 +184,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
183184
184185
```yaml
185186
- name: multiple command
186-
uses: appleboy/ssh-action@v1.1.0
187+
uses: appleboy/ssh-action@v1.2.0
187188
with:
188189
host: ${{ secrets.HOST }}
189190
username: ${{ secrets.USERNAME }}
@@ -196,11 +197,24 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
196197
197198
![result](./images/output-result.png)
198199
200+
#### Commands from a file
201+
202+
```yaml
203+
- name: file commands
204+
uses: appleboy/ssh-action@v1.2.0
205+
with:
206+
host: ${{ secrets.HOST }}
207+
username: ${{ secrets.USERNAME }}
208+
key: ${{ secrets.KEY }}
209+
port: ${{ secrets.PORT }}
210+
script_path: scripts/script.sh
211+
```
212+
199213
#### 多台主機
200214
201215
```diff
202216
- name: multiple host
203-
uses: appleboy/ssh-action@v1.1.0
217+
uses: appleboy/ssh-action@v1.2.0
204218
with:
205219
- host: "foo.com"
206220
+ host: "foo.com,bar.com"
@@ -216,7 +230,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
216230
217231
```diff
218232
- name: multiple host
219-
uses: appleboy/ssh-action@v1.1.0
233+
uses: appleboy/ssh-action@v1.2.0
220234
with:
221235
- host: "foo.com"
222236
+ host: "foo.com:1234,bar.com:5678"
@@ -231,7 +245,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
231245
232246
```diff
233247
- name: multiple host
234-
uses: appleboy/ssh-action@v1.1.0
248+
uses: appleboy/ssh-action@v1.2.0
235249
with:
236250
host: "foo.com,bar.com"
237251
+ sync: true
@@ -247,7 +261,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
247261
248262
```diff
249263
- name: pass environment
250-
uses: appleboy/ssh-action@v1.1.0
264+
uses: appleboy/ssh-action@v1.2.0
251265
+ env:
252266
+ FOO: "BAR"
253267
+ BAR: "FOO"
@@ -272,7 +286,7 @@ _在 `env` 對象中，您需要將每個環境變量作為字符串傳遞，傳
272286

273287
```diff
274288
- name: stop script if command error
275-
uses: appleboy/ssh-action@v1.1.0
289+
uses: appleboy/ssh-action@v1.2.0
276290
with:
277291
host: ${{ secrets.HOST }}
278292
username: ${{ secrets.USERNAME }}
@@ -325,7 +339,7 @@ Host FooServer
325339

326340
```diff
327341
- name: ssh proxy command
328-
uses: appleboy/ssh-action@v1.1.0
342+
uses: appleboy/ssh-action@v1.2.0
329343
with:
330344
host: ${{ secrets.HOST }}
331345
username: ${{ secrets.USERNAME }}
@@ -346,7 +360,7 @@ Host FooServer
346360

347361
```diff
348362
- name: ssh key passphrase
349-
uses: appleboy/ssh-action@v1.1.0
363+
uses: appleboy/ssh-action@v1.2.0
350364
with:
351365
host: ${{ secrets.HOST }}
352366
username: ${{ secrets.USERNAME }}
@@ -372,7 +386,7 @@ ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ' '
372386

373387
```diff
374388
- name: ssh key passphrase
375-
uses: appleboy/ssh-action@v1.1.0
389+
uses: appleboy/ssh-action@v1.2.0
376390
with:
377391
host: ${{ secrets.HOST }}
378392
username: ${{ secrets.USERNAME }}

0 commit comments

Comments
 (0)