docs: update desctiption
This commit is contained in:
parent
fcfb760891
commit
03b5d10ad6
|
@ -45,8 +45,8 @@ out: ***
|
||||||
|
|
||||||
See [action.yml](./action.yml) for more detailed information.
|
See [action.yml](./action.yml) for more detailed information.
|
||||||
|
|
||||||
* host - remote host
|
* host - ssh host
|
||||||
* port - remote port, default is `22`
|
* port - ssh port, default is `22`
|
||||||
* username - ssh username
|
* username - ssh username
|
||||||
* password - ssh password
|
* password - ssh password
|
||||||
* passphrase - the passphrase is usually to encrypt the private key
|
* passphrase - the passphrase is usually to encrypt the private key
|
||||||
|
|
10
action.yml
10
action.yml
|
@ -3,9 +3,9 @@ description: 'Executing remote ssh commands'
|
||||||
author: 'Bo-Yi Wu'
|
author: 'Bo-Yi Wu'
|
||||||
inputs:
|
inputs:
|
||||||
host:
|
host:
|
||||||
description: 'ssh remote host'
|
description: 'ssh host'
|
||||||
port:
|
port:
|
||||||
description: 'ssh remote port'
|
description: 'ssh port'
|
||||||
default: 22
|
default: 22
|
||||||
passphrase:
|
passphrase:
|
||||||
description: 'ssh key passphrase'
|
description: 'ssh key passphrase'
|
||||||
|
@ -17,7 +17,7 @@ inputs:
|
||||||
description: 'synchronous execution if multiple hosts'
|
description: 'synchronous execution if multiple hosts'
|
||||||
default: false
|
default: false
|
||||||
timeout:
|
timeout:
|
||||||
description: 'timeout for ssh to remote host'
|
description: 'timeout for ssh to host'
|
||||||
default: "30s"
|
default: "30s"
|
||||||
command_timeout:
|
command_timeout:
|
||||||
description: 'timeout for ssh command'
|
description: 'timeout for ssh command'
|
||||||
|
@ -27,9 +27,9 @@ inputs:
|
||||||
key_path:
|
key_path:
|
||||||
description: 'path of ssh private key'
|
description: 'path of ssh private key'
|
||||||
proxy_host:
|
proxy_host:
|
||||||
description: 'ssh proxy remote host'
|
description: 'ssh proxy host'
|
||||||
proxy_port:
|
proxy_port:
|
||||||
description: 'ssh proxy remote port'
|
description: 'ssh proxy port'
|
||||||
default: 22
|
default: 22
|
||||||
proxy_username:
|
proxy_username:
|
||||||
description: 'ssh proxy username'
|
description: 'ssh proxy username'
|
||||||
|
|
Loading…
Reference in New Issue