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

Merge pull request #34 from alfreddagenais/master

Browse Source 
Ajustement for Readme file
This commit is contained in:
wl
2022-07-14 13:42:29 +08:00
committed by GitHub
parent da88a4dbe9 834e1ad841
commit 067de34294
2 changed files with 100 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

180
README.md
View File

@@ -18,102 +18,122 @@
`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 | Set `true` will delete all files in the remote path before upload. `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 `password`| no| | SSH passsword，If a password is set, `ssh_private_key` is ignored. `for @v1.2.4 and greater`
> **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
## Action Examples
```yaml
on: [push]
## Action Example jobs:
deploy_job:
runs-on: ubuntu-latest
name: deploy
steps:
- name: Checkout
uses: actions/checkout@v2
- name: deploy file
uses: wlixcc/SFTP-Deploy-Action@v1.2.4
with:
username: 'root'
server: 'your server ip'
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
local_path: './static/*'
remote_path: '/var/www/app'
sftpArgs: '-o ConnectTimeout=5'
```
```yaml
on: [push]
on: [push] jobs:
deploy_job:
jobs: runs-on: ubuntu-latest
deploy_job: name: deploy
runs-on: ubuntu-latest steps:
name: deploy - name: Checkout
steps: uses: actions/checkout@v2
- name: Checkout - name: Deploy file
uses: actions/checkout@v2 uses: wlixcc/SFTP-Deploy-Action@v1.2.4
- name: deploy file with:
uses: wlixcc/SFTP-Deploy-Action@v1.2.3 username: ${{ secrets.FTP_USERNAME }}
with: server: ${{ secrets.FTP_SERVER }}
username: 'root' port: ${{ secrets.FTP_PORT }}
server: 'your server ip' local_path: './static/*'
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }} remote_path: '/var/www/app'
local_path: './static/*' sftp_only: true
remote_path: '/var/www/app' password: ${{ secrets.FTP_PASSWORD }}
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)
> If you use nginx, all you need to do is upload the static files to the server after the project is built > If you use nginx, all you need to do is upload the static files to the server after the project is built
on: [push] ```yaml
on: [push]
jobs:
deploy_job: jobs:
runs-on: ubuntu-latest deploy_job:
name: build&deploy runs-on: ubuntu-latest
steps: name: build&deploy
# To use this repository's private action, you must check out the repository steps:
- name: Checkout # To use this repository's private action, you must check out the repository
uses: actions/checkout@v2 - name: Checkout
uses: actions/checkout@v2
- name: Install Dependencies
run: yarn - name: Install Dependencies
- name: Build run: yarn
run: yarn build - name: Build
run: yarn build
- name: deploy file to server
uses: wlixcc/SFTP-Deploy-Action@v1.2.4 - name: deploy file to server
with: uses: wlixcc/SFTP-Deploy-Action@v1.2.4
username: 'root' with:
server: '${{ secrets.SERVER_IP }}' username: 'root'
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }} server: '${{ secrets.SERVER_IP }}'
local_path: './build/*' ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
remote_path: '/var/www/react-app' local_path: './build/*'
sftpArgs: '-o ConnectTimeout=5' remote_path: '/var/www/react-app'
sftpArgs: '-o ConnectTimeout=5'
```
![](./resource/reactExample.jpg) ![](./resource/reactExample.jpg)
## 2.Deploy Umi App Example (Ant Design Pro) ## 2.Deploy Umi App Example (Ant Design Pro)
name: continuous deployment ```yaml
on: [push] name: continuous deployment
on: [push]
jobs:
deploy_job:
runs-on: ubuntu-latest
name: build&deploy
steps:
# To use this repository's private action, you must check out the repository
- name: Checkout
uses: actions/checkout@v2
- name: Install umi
run: yarn global add umi
- name: Install Dependencies
run: yarn
- name: Build
run: yarn build
- name: deploy file to server
uses: wlixcc/SFTP-Deploy-Action@v1.2.4
with:
username: 'root'
server: '${{ secrets.SERVER_IP }}'
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
local_path: './dist/*'
remote_path: '/var/www/umiapp'
sftpArgs: '-o ConnectTimeout=5'
![](./resource/umiExample.jpg)
jobs:
deploy_job:
runs-on: ubuntu-latest
name: build&deploy
steps:
# To use this repository's private action, you must check out the repository
- name: Checkout
uses: actions/checkout@v2
- name: Install umi
run: yarn global add umi
- name: Install Dependencies
run: yarn
- name: Build
run: yarn build
- name: deploy file to server
uses: wlixcc/SFTP-Deploy-Action@v1.2.4
with:
username: 'root'
server: '${{ secrets.SERVER_IP }}'
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
local_path: './dist/*'
remote_path: '/var/www/umiapp'
sftpArgs: '-o ConnectTimeout=5'
```
![](./resource/umiExample.jpg)

3
entrypoint.sh
View File

@@ -3,7 +3,6 @@
#set -e at the top of your script will make the script exit with an error whenever an error occurs (and is not explicitly handled) #set -e at the top of your script will make the script exit with an error whenever an error occurs (and is not explicitly handled)
set -eu set -eu
TEMP_SSH_PRIVATE_KEY_FILE='../private_key.pem' TEMP_SSH_PRIVATE_KEY_FILE='../private_key.pem'
TEMP_SFTP_FILE='../sftp' TEMP_SFTP_FILE='../sftp'
@@ -13,7 +12,6 @@ if [ -z "$6" ]; then
exit 1 exit 1
fi fi
# use password # use password
if [ -z != ${10} ]; then if [ -z != ${10} ]; then
echo 'use sshpass' echo 'use sshpass'
@@ -67,4 +65,3 @@ sftp -b $TEMP_SFTP_FILE -P $3 $8 -o StrictHostKeyChecking=no -i $TEMP_SSH_PRIVAT
echo 'Deploy Success' echo 'Deploy Success'
exit 0 exit 0