docs: describe true usage of allenvs parameter (#301)

This commit is contained in:
Kushal Dhakal 2024-03-16 07:28:37 +05:45 committed by GitHub
parent 9b978f09f2
commit 8a779a5b1a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -24,7 +24,7 @@ See [action.yml](./action.yml) for more detailed information.
| username | SSH username | | | username | SSH username | |
| password | SSH password | | | password | SSH password | |
| sync | Enable synchronous execution if multiple hosts | false | | sync | Enable synchronous execution if multiple hosts | false |
| use_insecure_cipher | Include more ciphers with use_insecure_cipher | false | | use_insecure_cipher | Include more ciphers with use_insecure_cipher | false |
| cipher | Allowed cipher algorithms. If unspecified, a sensible default | | | cipher | Allowed cipher algorithms. If unspecified, a sensible default | |
| timeout | Timeout duration for SSH to host | 30s | | timeout | Timeout duration for SSH to host | 30s |
| command_timeout | Timeout duration for SSH command | 10m | | command_timeout | Timeout duration for SSH command | 10m |
@ -36,19 +36,19 @@ See [action.yml](./action.yml) for more detailed information.
| proxy_username | SSH proxy username | | | proxy_username | SSH proxy username | |
| proxy_password | SSH proxy password | | | proxy_password | SSH proxy password | |
| proxy_passphrase | SSH proxy key passphrase | | | proxy_passphrase | SSH proxy key passphrase | |
| proxy_timeout | Timeout for SSH to proxy host | 30s | | proxy_timeout | Timeout for SSH to proxy host | 30s |
| proxy_key | Content of SSH proxy private key | | | proxy_key | Content of SSH proxy private key | |
| proxy_key_path | Path of SSH proxy private key | | | proxy_key_path | Path of SSH proxy private key | |
| proxy_fingerprint | SHA256 fingerprint of the proxy host public key | | | proxy_fingerprint | SHA256 fingerprint of the proxy host public key | |
| proxy_cipher | Allowed cipher algorithms for the proxy | | | proxy_cipher | Allowed cipher algorithms for the proxy | |
| proxy_use_insecure_cipher | Include more ciphers with use_insecure_cipher for the proxy | false | | proxy_use_insecure_cipher | Include more ciphers with use_insecure_cipher for the proxy | false |
| script | Execute commands | | | script | Execute commands | |
| script_stop | Stop script after first failure | false | | script_stop | Stop script after first failure | false |
| envs | Pass environment variables to shell script | | | envs | Pass environment variables to shell script | |
| envs_format | Flexible configuration of environment value transfer | | | envs_format | Flexible configuration of environment value transfer | |
| debug | Enable debug mode | false | | debug | Enable debug mode | false |
| allenvs | Pass all environment variables to shell script | false | | 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 | | request_pty | Request a pseudo-terminal from the server | false |
## Usage ## Usage