actions/scp-action
1
0
Fork 0
mirror of https://github.com/appleboy/scp-action.git synced 2024-11-12 04:28:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update target and source fields in README and action.yml descriptions

Browse Source 
- 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 <appleboy.tw@gmail.com>
This commit is contained in:
Bo-Yi.Wu 2023-04-09 16:38:43 +08:00
parent a4e63f0f1a
commit d47875703f
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -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

2
action.yml
View File

@ -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: