Skip to content

Commit f007431

Browse files
authored
fix: Update README.md
1 parent ece05a2 commit f007431

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,19 +67,27 @@ Execution is preformed by storing commands in `.sh` file and executing it via `.
6767
If you have issues with `ssh` connection, use this var, eg `SCRIPT_BEFORE: ls`.
6868
This will force `known_hosts` update, adding your host via `ssh-keyscan`.
6969

70-
##### 10. `SCRIPT_AFTER` (optional, default '')
70+
##### 10. `SCRIPT_BEFORE_REQUIRED` (optional, default false)
71+
72+
If set to `true`, Job will fail if SCRIPT_BEFORE fails.
73+
74+
##### 11. `SCRIPT_AFTER` (optional, default '')
7175

7276
Script to run on host machine after rsync.
7377
Rsync output is stored in `$RSYNC_STDOUT` env variable.
7478

75-
##### 11. `SSH_CMD_ARGS` (optional, default '-o StrictHostKeyChecking=no')
79+
##### 12. `SCRIPT_AFTER_REQUIRED` (optional, default false)
80+
81+
If set to `true`, Job will fail if SCRIPT_AFTER fails.
82+
83+
##### 13. `SSH_CMD_ARGS` (optional, default '-o StrictHostKeyChecking=no')
7684

7785
A list of ssh arguments, they must be prefixed with -o and separated by a comma, for example: -o SomeArgument=no, -o SomeOtherArgument=5
7886

7987

8088
# Usage
8189

82-
Use the latest version from Marketplace,eg: ssh-deploy@v2
90+
Use the latest version from Marketplace,eg: ssh-deploy@v5.1.0
8391
or use the latest version from a branch, eg: ssh-deploy@main
8492

8593
```

0 commit comments

Comments
 (0)