mirror of
https://github.com/ChenjxJames/SFTP-Deploy-Action.git
synced 2025-09-11 21:25:45 +08:00
Compare commits
3 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
7dde96b18c | ||
|
9289a89a12 | ||
|
4404f4759c |
170
README.md
170
README.md
@@ -1,12 +1,9 @@
|
|||||||
# SFTP Deploy action
|
# SFTP Deploy action
|
||||||
|
|
||||||
> Use this action to deploy your files to server using `SSH Private Key`
|
> Use this action to deploy your files to server using `SSH Private Key`
|
||||||
|
|
||||||
> 使用此`action`部署你的项目到服务器上,`仅支持密钥对连接`
|
> 使用此`action`部署你的项目到服务器上,`仅支持密钥对连接`
|
||||||
|
|
||||||
> [使用Github Action 部署项目到云服务器](https://zhuanlan.zhihu.com/p/107545396)
|
> [使用Github Action 部署项目到云服务器](https://zhuanlan.zhihu.com/p/107545396)
|
||||||
|
|
||||||
|
|
||||||
## Inputs
|
## Inputs
|
||||||
|
|
||||||
### `username`
|
### `username`
|
||||||
@@ -25,108 +22,109 @@ sftp srever port , default `22`
|
|||||||
|
|
||||||
**Required** you can copy private_key from your `ssh_private_key.pem file`, keep format, and save at`repo/settings/secrets`
|
**Required** you can copy private_key from your `ssh_private_key.pem file`, keep format, and save at`repo/settings/secrets`
|
||||||
|
|
||||||
|

|
||||||

|
|
||||||
|
|
||||||
### `local_path`
|
### `local_path`
|
||||||
|
|
||||||
**Required** `local_path` of you project, if you want put single file:use path like `./myfile`, if you want put directory: use path like `./static/*`, it will put all files under `static` directory. Default to `./*`(will put all files in your repo).
|
**Required** `local_path` of you project, if you want put single file:use path like `./myfile`, if you want put directory: use path like `./static/*`, it will put all files under `static` directory. Default to `./*`(will put all files in your repo).
|
||||||
|
|
||||||
### `remote_path`
|
### `remote_path`
|
||||||
|
|
||||||
**Required** remote_path
|
**Required** remote_path
|
||||||
|
|
||||||
### `args`
|
### `args`
|
||||||
|
|
||||||
args of sftp cmd, E.g.`-o ConnectTimeout=5`
|
args of sftp cmd, E.g.`-o ConnectTimeout=5`
|
||||||
|
|
||||||
|
## Action Example
|
||||||
|
|
||||||
## Action Example
|
```yml
|
||||||
|
on: [push]
|
||||||
|
|
||||||
|
jobs:
|
||||||
on: [push]
|
deploy_job:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
jobs:
|
name: deploy
|
||||||
deploy_job:
|
steps:
|
||||||
runs-on: ubuntu-latest
|
- name: Checkout
|
||||||
name: deploy
|
uses: actions/checkout@v2
|
||||||
steps:
|
- name: deploy file
|
||||||
- name: Checkout
|
uses: ChenjxJames/SFTP-Deploy-Action@v1.3.2
|
||||||
uses: actions/checkout@v2
|
with:
|
||||||
- name: deploy file
|
username: 'root'
|
||||||
uses: wlixcc/SFTP-Deploy-Action@v1.0
|
server: 'your server ip'
|
||||||
with:
|
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
|
||||||
username: 'root'
|
local_path: './static/*'
|
||||||
server: 'your server ip'
|
remote_path: '/var/www/app'
|
||||||
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
|
args: '-o ConnectTimeout=5'
|
||||||
local_path: './static/*'
|
```
|
||||||
remote_path: '/var/www/app'
|
|
||||||
args: '-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]
|
```yml
|
||||||
|
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.0
|
|
||||||
with:
|
|
||||||
username: 'root'
|
|
||||||
server: '${{ secrets.SERVER_IP }}'
|
|
||||||
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
|
|
||||||
local_path: './build/*'
|
|
||||||
remote_path: '/var/www/react-app'
|
|
||||||
args: '-o ConnectTimeout=5'
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
|
- name: deploy file to server
|
||||||
|
uses: ChenjxJames/SFTP-Deploy-Action@v1.3.2
|
||||||
|
with:
|
||||||
|
username: 'root'
|
||||||
|
server: '${{ secrets.SERVER_IP }}'
|
||||||
|
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
|
||||||
|
local_path: './build/*'
|
||||||
|
remote_path: '/var/www/react-app'
|
||||||
|
args: '-o ConnectTimeout=5'
|
||||||
|
```
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## 2.Deploy Umi App Example (Ant Design Pro)
|
## 2.Deploy Umi App Example (Ant Design Pro)
|
||||||
|
|
||||||
name: continuous deployment
|
```yml
|
||||||
on: [push]
|
name: continuous deployment
|
||||||
|
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 umi
|
|
||||||
run: yarn global add umi
|
- name: Install umi
|
||||||
|
run: yarn global add umi
|
||||||
- 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.0
|
- name: deploy file to server
|
||||||
with:
|
uses: ChenjxJames/SFTP-Deploy-Action@v1.3.2
|
||||||
username: 'root'
|
with:
|
||||||
server: '${{ secrets.SERVER_IP }}'
|
username: 'root'
|
||||||
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
|
server: '${{ secrets.SERVER_IP }}'
|
||||||
local_path: './dist/*'
|
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
|
||||||
remote_path: '/var/www/umiapp'
|
local_path: './dist/*'
|
||||||
args: '-o ConnectTimeout=5'
|
remote_path: '/var/www/umiapp'
|
||||||

|
args: '-o ConnectTimeout=5'
|
||||||
|
```
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
# action.yml
|
# action.yml
|
||||||
name: 'SFTP Deploy'
|
name: 'SFTP Deploy No SSH'
|
||||||
description: 'Deploy file to your server use sftp & ssh private key'
|
description: 'Deploy file to your server use sftp & ssh private key'
|
||||||
inputs:
|
inputs:
|
||||||
username:
|
username:
|
||||||
|
@@ -12,10 +12,6 @@ printf "%s" "$4" >$TEMP_SSH_PRIVATE_KEY_FILE
|
|||||||
# avoid Permissions too open
|
# avoid Permissions too open
|
||||||
chmod 600 $TEMP_SSH_PRIVATE_KEY_FILE
|
chmod 600 $TEMP_SSH_PRIVATE_KEY_FILE
|
||||||
|
|
||||||
echo 'ssh start'
|
|
||||||
|
|
||||||
ssh -o StrictHostKeyChecking=no -p $3 -i $TEMP_SSH_PRIVATE_KEY_FILE $1@$2 mkdir -p $6
|
|
||||||
|
|
||||||
echo 'sftp start'
|
echo 'sftp start'
|
||||||
# create a temporary file containing sftp commands
|
# create a temporary file containing sftp commands
|
||||||
printf "%s" "put -r $5 $6" >$TEMP_SFTP_FILE
|
printf "%s" "put -r $5 $6" >$TEMP_SFTP_FILE
|
||||||
|
Reference in New Issue
Block a user