wdhcr/SFTP-Deploy-Action
1
0
Fork 0
mirror of https://gitee.com/jack_whh/SFTP-Deploy-Action.git synced 2026-03-09 23:12:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

1. update readme

Browse Source
This commit is contained in:
wl
2022-07-01 09:26:31 +08:00
parent 6596a6c48c
commit e57406ff6c
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -17,11 +17,12 @@
`remote_path`|yes|| Remote path `remote_path`|yes|| Remote path
`sftp_only`| no| | If your port only accepts the sftp protocol, set this option to `true`. However, please note that when this option is set to `true`, the remote folder will not be created automatically. `sftp_only`| no| | If your port only accepts the sftp protocol, set this option to `true`. However, please note that when this option is set to `true`, the remote folder will not be created automatically.
<strike>args</strike> `sftpArgs` | no| | other args yor want to use of sftp, E.g.`-o ConnectTimeout=5` <strike>args</strike> `sftpArgs` | no| | other args yor want to use of sftp, E.g.`-o ConnectTimeout=5`
`delete_remote_files` | no | false | **Warning** Set `true` will delete all files in the remote path before upload. Please be `careful` set this to true `delete_remote_files` | no | false | Set `true` will delete all files in the remote path before upload.
`passowrd`| no| | SSH passsword，If a password is set, `ssh_private_key` is ignored `passowrd`| no| | SSH passsword，If a password is set, `ssh_private_key` is ignored
> **Warning** > **Warning**
> be `careful` when use `delete_remote_files` This will remove all files in your remote path before uploading
> Be careful when use `delete_remote_files`, This will remove all files in your remote path before uploading
@@ -45,7 +46,7 @@
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }} ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
local_path: './static/*' local_path: './static/*'
remote_path: '/var/www/app' remote_path: '/var/www/app'
args: '-o ConnectTimeout=5' sftpArgs: '-o ConnectTimeout=5'
## 1. [Deploy React App Example](https://github.com/wlixcc/React-Deploy) ## 1. [Deploy React App Example](https://github.com/wlixcc/React-Deploy)