Skip to content

Commit 9273705

Browse files
committed
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 <[email protected]>
1 parent 9817ef4 commit 9273705

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ See [action.yml](./action.yml) for more detailed information.
2222
| username | SSH username | |
2323
| password | SSH password | |
2424
| protocol | SSH protocol version (tcp, tcp4, tcp6) | tcp |
25-
| sync | Enable synchronous execution if multiple hosts | false |
25+
| sync | Enable synchronous execution if multiple hosts are specified | false |
2626
| use_insecure_cipher | Include more ciphers with use_insecure_cipher | false |
27-
| cipher | Allowed cipher algorithms. If unspecified, a sensible default | |
27+
| cipher | Allowed cipher algorithms. If unspecified, sensible defaults are used | |
2828
| timeout | Timeout duration for SSH to host | 30s |
2929
| command_timeout | Timeout duration for SSH command | 10m |
3030
| key | Content of SSH private key. e.g., raw content of ~/.ssh/id_rsa | |
@@ -44,7 +44,7 @@ See [action.yml](./action.yml) for more detailed information.
4444
| proxy_use_insecure_cipher | Include more ciphers with use_insecure_cipher for the proxy | false |
4545
| script | Execute commands | |
4646
| script_path | Execute commands from a file | |
47-
| envs | Pass environment variables to shell script | |
47+
| envs | Pass environment variables to the shell script | |
4848
| envs_format | Flexible configuration of environment value transfer | |
4949
| debug | Enable debug mode | false |
5050
| allenvs | Pass the environment variables with prefix value of `GITHUB_` and `INPUT_` to the script | false |

0 commit comments

Comments
 (0)