suyiiyii/ssh-action
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: improve action.yml clarity and update default values

Browse Source 
- Update descriptions for input fields in action.yml for better clarity
- Change default values for SSH port and SSH proxy port to string format

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
This commit is contained in:
Bo-Yi Wu 2023-06-04 11:06:25 +08:00
parent d87d276960
commit f579d71942
1 changed files with 31 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
action.yml
View File

@ -3,73 +3,68 @@ description: 'Executing remote ssh commands'
author: 'Bo-Yi Wu' author: 'Bo-Yi Wu'
inputs: inputs:
host: host:
description: 'ssh host' description: 'SSH host address.'
port: port:
description: 'ssh port' description: 'SSH port number.'
default: 22 default: "22"
passphrase: passphrase:
description: 'ssh key passphrase' description: 'Passphrase for the SSH key.'
username: username:
description: 'ssh username' description: 'SSH username.'
password: password:
description: 'ssh password' description: 'SSH password.'
sync: sync:
description: 'synchronous execution if multiple hosts' description: 'Enable synchronous execution if multiple hosts are involved.'
default: false
use_insecure_cipher: use_insecure_cipher:
description: 'include more ciphers with use_insecure_cipher' description: 'Include more ciphers by using insecure ciphers.'
default: false
cipher: cipher:
description: 'the allowed cipher algorithms. If unspecified then a sensible' description: 'Allowed cipher algorithms. If unspecified, a sensible default is used.'
timeout: timeout:
description: 'timeout for ssh to host' description: 'Timeout duration for establishing SSH connection to the host.'
default: "30s" default: "30s"
command_timeout: command_timeout:
description: 'timeout for ssh command' description: 'Timeout duration for SSH commands execution.'
default: "10m" default: "10m"
key: key:
description: 'content of ssh private key. ex raw content of ~/.ssh/id_rsa' description: 'Content of the SSH private key. For example, the raw content of ~/.ssh/id_rsa.'
key_path: key_path:
description: 'path of ssh private key' description: 'Path to the SSH private key file.'
fingerprint: fingerprint:
description: 'sha256 fingerprint of the host public key' description: 'SHA256 fingerprint of the host public key.'
proxy_host: proxy_host:
description: 'ssh proxy host' description: 'SSH proxy host address.'
proxy_port: proxy_port:
description: 'ssh proxy port' description: 'SSH proxy port number.'
default: 22 default: "22"
proxy_username: proxy_username:
description: 'ssh proxy username' description: 'SSH proxy username.'
proxy_password: proxy_password:
description: 'ssh proxy password' description: 'SSH proxy password.'
proxy_passphrase: proxy_passphrase:
description: 'ssh proxy key passphrase' description: 'SSH proxy key passphrase.'
proxy_timeout: proxy_timeout:
description: 'timeout for ssh to proxy host' description: 'Timeout duration for establishing SSH connection to the proxy host.'
default: "30s" default: "30s"
proxy_key: proxy_key:
description: 'content of ssh proxy private key. ex raw content of ~/.ssh/id_rsa' description: 'Content of the SSH proxy private key. For example, the raw content of ~/.ssh/id_rsa.'
proxy_key_path: proxy_key_path:
description: 'path of ssh proxy private key' description: 'Path to the SSH proxy private key file.'
proxy_fingerprint: proxy_fingerprint:
description: 'sha256 fingerprint of the proxy host public key' description: 'SHA256 fingerprint of the proxy host public key.'
proxy_cipher: proxy_cipher:
description: 'the allowed cipher algorithms. If unspecified then a sensible' description: 'Allowed cipher algorithms for the proxy. If unspecified, a sensible default is used.'
proxy_use_insecure_cipher: proxy_use_insecure_cipher:
description: 'include more ciphers with use_insecure_cipher' description: 'Include more ciphers for the proxy by using insecure ciphers.'
default: false
script: script:
description: 'execute commands' description: 'Commands to be executed.'
script_stop: script_stop:
description: 'stop script after first failure' description: 'Stop the script after the first failure.'
default: false
envs: envs:
description: 'pass environment variable to shell script' description: 'Environment variables to be passed to the shell script.'
envs_format: envs_format:
description: 'flexible configuration of environment value transfer' description: 'Flexible configuration for environment value transfer.'
debug: debug:
description: 'enable debug mode' description: 'Enable debug mode.'
default: false
runs: runs:
using: 'docker' using: 'docker'
image: 'Dockerfile' image: 'Dockerfile'