From d47875703ff9af01a2b632dc14b824aabdf5b1fa Mon Sep 17 00:00:00 2001 From: "Bo-Yi.Wu" Date: Sun, 9 Apr 2023 16:38:43 +0800 Subject: [PATCH] docs: update target and source fields in README and action.yml descriptions - Change in README.md: Updated required fields for `target` and `source` - Change in action.yml: Updated description for `target` input field Signed-off-by: Bo-Yi.Wu --- README.md | 4 ++-- action.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 72366ce..7e7ddad 100644 --- a/README.md +++ b/README.md @@ -45,8 +45,8 @@ See the [action.yml](./action.yml) file for more detail information. * command_timeout - timeout for scp command, default is `10m` * key - content of ssh private key. ex raw content of ~/.ssh/id_rsa * key_path - path of ssh private key -* target - target path on the server -* source - scp file list +* target - target path on the server, must be a directory (**required**) +* source - scp file list (**required**) * rm - remove target folder before upload data, default is `false` * strip_components - remove the specified number of leading path elements. * overwrite - use `--overwrite` flag with tar, overwrite existing files when extracting diff --git a/action.yml b/action.yml index 5ecab88..a322c3d 100644 --- a/action.yml +++ b/action.yml @@ -29,7 +29,7 @@ inputs: description: 'include more ciphers with use_insecure_cipher' default: false target: - description: 'target path on the server' + description: 'target path on the server, must be a directory path.' source: description: 'scp file list' rm: