ssh-action/action.yml
Bo-Yi Wu f579d71942 chore: improve action.yml clarity and update default values
- 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>
2023-06-04 11:06:25 +08:00

75 lines
2.4 KiB
YAML

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