actions
/
SFTP-Deploy-Action
mirror of https://github.com/wlixcc/SFTP-Deploy-Action.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Compare commits

base: actions:master
Branches Tags
actions:master
actions:test
actions:v1.2.6
actions:v1.2.5
actions:v1.2.4
actions:v1.2.3
actions:v1.2.2
actions:v1.2.1
actions:v1.2
actions:1.1
actions:v1.0
..
compare: actions:v1.2.3
Branches Tags
actions:master
actions:test
actions:v1.2.6
actions:v1.2.5
actions:v1.2.4
actions:v1.2.3
actions:v1.2.2
actions:v1.2.1
actions:v1.2
actions:1.1
actions:v1.0

No commits in common. "master" and "v1.2.3" have entirely different histories.
master ... v1.2.3

6 changed files with 126 additions and 296 deletions
Show Stats Expand all files Collapse all files

19
.github/workflows/main.yml vendored
View File

@ -1,26 +1,21 @@
name: Continuous Deploy
on: [push]
name: Continuous Deploy #action名称
on: [push] #在推送的时候运行此action
jobs:
deploy_job:
runs-on: ubuntu-latest
runs-on: ubuntu-latest #运行环境
name: sftp
steps:
- name: Checkout
uses: actions/checkout@v2
# 利用action把build好的文件上传到服务器/var/www/react-app路径下,需要确认此目录已在服务端创建
- name: deploy file to server
uses: ./ # Uses an action in the root directory
with:
username: '${{ secrets.USER }}'
username: 'root' #ssh user name
server: '${{ secrets.SERVER_IP }}'
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
local_path: './*'
remote_path: '/tmp/testAction'
sftpArgs: '-o ConnectTimeout=5'
rsyncArgs: '--exclude *.yml'
# sftp_only: true
# password: ${{secrets.SSH_PASSWORD}}
local_path: './action.yml' # 对应我们项目build的文件夹路径
remote_path: '/var/www/react-app/'
# delete_remote_files: true

21
Dockerfile
View File

@ -1,12 +1,15 @@
# Use an up-to-date and secure Alpine version
FROM alpine:3.18
# Container image that runs your code
FROM alpine:3.13
# Install required packages in one RUN statement to reduce image layers
RUN apk update && apk add --no-cache rsync sshpass openssh expect
# Copy entrypoint script and set correct permissions
# Copies your code file from your action repository to the filesystem path `/` of the container
COPY entrypoint.sh /entrypoint.sh
RUN chmod +x /entrypoint.sh
# Set the entrypoint for the container
ENTRYPOINT ["/bin/sh", "/entrypoint.sh"]
#Make sure to make you entrypoint.sh file executable:
RUN chmod 777 entrypoint.sh
RUN apk update
RUN apk add --no-cache openssh
# Code file to execute when the docker container starts up (`entrypoint.sh`)
ENTRYPOINT ["/entrypoint.sh"]

192
README.md
View File

@ -1,190 +1,112 @@
# 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 a server using `SSH Private Key`
> 使用此`action`部署你的项目到服务器上,`仅支持密钥对连接`
中文介绍链接：[使用Github Action 部署项目到云服务器](https://zhuanlan.zhihu.com/p/107545396)
> 使用此 `action` 部署你的项目到服务器上，中文介绍链接：[使用Github Action 部署项目到云服务器](https://zhuanlan.zhihu.com/p/107545396)
---
## 🚀 **1. Inputs**
## 1. Inputs
| Name | Required | Default | Description |
|------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------|
| `username` | yes | | SSH username |
| `server` | yes | | Remote host |
| `port` | yes | 22 | Remote host port |
| `ssh_private_key` | no | | You can copy the private key from your `ssh_private_key` file and save it to `repo/settings/secrets`<br> ![](./resource/secret.jpg) |
| `local_path` | yes | `./*` | Local path of your project. <br> - Single file: `./myfile` <br> - Directory: `./static/*` <br> Default: `./*` (will put all files in your repo). |
| `remote_path` | yes | | The target folder on the remote server. |
| `sftp_only` | no | | If your port only accepts the sftp protocol, set this option to `true`. However, when set to `true`, the remote folder won't be automatically created. |
| `sftpArgs` | no | | Extra arguments you want to pass to `sftp`, for example: `-o ConnectTimeout=5` |
| `delete_remote_files` | no | false | Set to `true` to delete the remote path folder and all files in it **before** uploading. |
| `password` | no | | SSH password. If a password is set, `ssh_private_key` and `ssh_passphrase` is ignored. *(for @v1.2.4 and greater)* |
| `rsyncArgs` | no | | Additional arguments for the `rsync` command. You can customize file synchronization behavior, such as excluding files or directories. Example: `--exclude=node_modules --exclude=.git --exclude=*.log`. *(for @v1.2.5 and greater)* |
| `ssh_passphrase` | no | | The passphrase for encrypted ssh private-key |
|------------------------|----------------------|---------|-----------------------------------------------|
`username` | yes| | SSH username
`server` | yes| | Remote host
`port`| yes | 22 | Remote host port
`ssh_private_key`| yes| | You can copy private key from your `ssh_private_key.pem` file, and save to`repo/settings/secrets`![](./resource/secret.jpg)
`local_path`| yes| ./* | `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`|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.
`args` | 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. Please be `careful` set this to true
> ⚠️ **Warning:**
> Be careful when using `delete_remote_files`. This will **permanently delete** the remote path folder and all files in it **before** uploading.
## Action Example
---
## 📦 **2. Action Examples**
### **🔹 Basic Example**
```yaml
on: [push]
jobs:
deploy_job:
runs-on: ubuntu-latest
name: Deploy Files
name: deploy
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Deploy to Server
uses: wlixcc/SFTP-Deploy-Action@v1.2.6
- name: deploy file
uses: wlixcc/SFTP-Deploy-Action@v1.2.3
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'
```
args: '-o ConnectTimeout=5'
---
## 1. [Deploy React App Example](https://github.com/wlixcc/React-Deploy)
### **🔹 Example with rsyncArgs**
> If you use nginx, all you need to do is upload the static files to the server after the project is built
```yaml
on: [push]
jobs:
deploy_job:
runs-on: ubuntu-latest
name: Deploy with rsync exclude
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Deploy with Exclude Patterns
uses: wlixcc/SFTP-Deploy-Action@v1.2.6
with:
username: 'root'
server: 'your server ip'
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
local_path: './'
remote_path: '/var/www/app'
rsyncArgs: '--exclude=node_modules --exclude=.git --exclude=*.log'
sftpArgs: '-o ConnectTimeout=5'
```
---
### **🔹 Example with Password Authentication**
```yaml
on: [push]
jobs:
deploy_job:
runs-on: ubuntu-latest
name: Deploy with Password
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Deploy with Password
uses: wlixcc/SFTP-Deploy-Action@v1.2.6
with:
username: ${{ secrets.FTP_USERNAME }}
server: ${{ secrets.FTP_SERVER }}
port: ${{ secrets.FTP_PORT }}
local_path: './static/*'
remote_path: '/var/www/app'
sftp_only: true
password: ${{ secrets.FTP_PASSWORD }}
```
### **🔹 Example with Encrypted Private Key Authentication**
```yaml
on: [push]
jobs:
deploy_job:
runs-on: ubuntu-latest
name: Deploy with encrypted private key
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Deploy with encrypted private key
uses: wlixcc/SFTP-Deploy-Action@v1.2.6
with:
username: ${{ secrets.FTP_USERNAME }}
server: ${{ secrets.FTP_SERVER }}
port: ${{ secrets.FTP_PORT }}
local_path: './static/*'
remote_path: '/var/www/app'
sftp_only: true
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
ssh_passphrase: ${{ secrets.SSH_PASSPHRASE }}
```
---
## 🌐 **3. [Deploy React App Example](https://github.com/wlixcc/React-Deploy)**
```yaml
on: [push]
jobs:
deploy_job:
runs-on: ubuntu-latest
name: Build & Deploy React App
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 Dependencies
run: yarn
- name: Build
run: yarn build
- name: Deploy Build Folder
uses: wlixcc/SFTP-Deploy-Action@v1.2.6
- name: deploy file to server
uses: wlixcc/SFTP-Deploy-Action@v1.2.3
with:
username: 'root'
server: '${{ secrets.SERVER_IP }}'
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
local_path: './build/*'
remote_path: '/var/www/react-app'
rsyncArgs: '--exclude=*.map'
sftpArgs: '-o ConnectTimeout=5'
```
args: '-o ConnectTimeout=5'
![](./resource/reactExample.jpg)
---
## 2.Deploy Umi App Example (Ant Design Pro)
## 🛡️ **4. Invalid format? You need to keep the format**
name: continuous deployment
on: [push]
If you use the **Ed25519** algorithm to generate an SSH key pair:
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.3
with:
username: 'root'
server: '${{ secrets.SERVER_IP }}'
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
local_path: './dist/*'
remote_path: '/var/www/umiapp'
args: '-o ConnectTimeout=5'
![](./resource/umiExample.jpg)
```sh
ssh-keygen -t ed25519 -C "your_email@example.com"
```
⚠️ **Important:**
The last line of the private key **must remain a blank line** when adding it to **Repository Secrets**.
If you remove it, you might encounter an `invalid format` error.
![](./resource/keepformat.jpg)
---

24
action.yml
View File

@ -14,7 +14,7 @@ inputs:
default: "22"
ssh_private_key:
description: 'you can copy private_key from your *.pem file, keep format'
required: false
required: true
local_path:
description: 'will put all file under this path'
required: true
@ -26,26 +26,14 @@ inputs:
description: 'connection via sftp protocol only'
required: false
default: false
sftpArgs:
args:
description: 'sftp args'
required: false
delete_remote_files:
description: 'This operation will delete all files in the remote path before upload. Please be careful set this to true'
required: false
default: false
password:
description: "SSH passsword，If a password is set, the secret key pair is ignored"
required: false
rsyncArgs:
description: "Additional arguments for the rsync command.
You can use this parameter to customize the rsync behavior, such as excluding files or directories.
Example: '--exclude=node_modules --exclude=.git --exclude=*.log'.
If set, these arguments will be passed directly to the rsync command."
required: false
default: ""
ssh_passphrase:
description: "Passphrase for ssh encrypted private-key. If the private-key is not encrypted, this parameter is not required."
required: false
runs:
using: 'docker'
@ -58,12 +46,8 @@ runs:
- ${{ inputs.local_path }}
- ${{ inputs.remote_path }}
- ${{ inputs.sftp_only }}
- ${{ inputs.sftpArgs }}
- ${{ inputs.args }}
- ${{ inputs.delete_remote_files }}
- ${{ inputs.password }}
- ${{ inputs.rsyncArgs }}
- ${{ inputs.ssh_passphrase }}
branding:
icon: 'upload-cloud'

80
entrypoint.sh
View File

@ -3,74 +3,20 @@
#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
TEMP_SSH_PRIVATE_KEY_FILE='../private_key.pem'
TEMP_SFTP_FILE='../sftp'
# 定义一个本地临时目录，用于 rsync 过滤后存放文件
RSYNC_LOCAL_DEST="../filtered_upload"
RSYNC_ARGS="${11}"
# 如果用户“未”设置 exclude（EXCLUDE_PATTERNS 为空），则直接进入原逻辑
if [ -z "$RSYNC_ARGS" ]; then
echo "===> No rsync args provided, skip rsync filtering..."
else
echo "===> rsync args detected, start rsync filtering..."
# 先清理并创建该临时目录
rm -rf "$RSYNC_LOCAL_DEST"
mkdir -p "$RSYNC_LOCAL_DEST"
# 6) 打印完整的 rsync 命令，方便调试
echo "===> rsync command: rsync -av $RSYNC_ARGS $5 $RSYNC_LOCAL_DEST/"
# 执行 rsync 命令
rsync -av $RSYNC_ARGS $5 $RSYNC_LOCAL_DEST/
# 将 $5 替换为过滤后的目录下的所有文件，这样后面原脚本里 put -r $5 $6 就无需改动其他地方
set -- "$1" "$2" "$3" "$4" "$RSYNC_LOCAL_DEST/*" "$6" "$7" "$8" "$9" "${10}"
echo "===> Done rsync filtering. Continue original script..."
fi
# make sure remote path is not empty
if [ -z "$6" ]; then
echo 'remote_path is empty'
exit 1
fi
# use password
if [ -n "${10}" ]; then
echo 'use sshpass'
if test $9 == "true";then
echo 'Start delete remote files'
sshpass -p ${10} ssh -o StrictHostKeyChecking=no -p $3 $1@$2 rm -rf $6
fi
if test $7 = "true"; then
echo "Connection via sftp protocol only, skip the command to create a directory"
else
echo 'Create directory if needed'
sshpass -p ${10} ssh -o StrictHostKeyChecking=no -p $3 $1@$2 mkdir -p $6
fi
echo 'SFTP Start'
# create a temporary file containing sftp commands
printf "%s" "put -r $5 $6" >$TEMP_SFTP_FILE
#-o StrictHostKeyChecking=no avoid Host key verification failed.
SSHPASS=${10} sshpass -e sftp -oBatchMode=no -b $TEMP_SFTP_FILE -P $3 $8 -o StrictHostKeyChecking=no $1@$2
echo 'Deploy Success'
exit 0
fi
# keep string format
printf "%s" "$4" >$TEMP_SSH_PRIVATE_KEY_FILE
# avoid Permissions too open
chmod 600 $TEMP_SSH_PRIVATE_KEY_FILE
# delete remote files if needed
if test $9 == "true";then
echo 'Start delete remote files'
ssh -o StrictHostKeyChecking=no -p $3 -i $TEMP_SSH_PRIVATE_KEY_FILE $1@$2 rm -rf $6
@ -79,24 +25,10 @@ fi
if test $7 = "true"; then
echo "Connection via sftp protocol only, skip the command to create a directory"
else
echo 'Create directory if needed'
echo 'SSH Start'
ssh -o StrictHostKeyChecking=no -p $3 -i $TEMP_SSH_PRIVATE_KEY_FILE $1@$2 mkdir -p $6
fi
# check if passphrase is set, if yes decrypt the private key
if [ -n "${12:-}" ]; then
echo 'Use ssh-agent to decrypt private key with passphrase'
# start ssh agent
eval $(ssh-agent -s)
# use expect for ssh passphrase encryption
expect <<EOF
spawn ssh-add $TEMP_SSH_PRIVATE_KEY_FILE
expect "Enter passphrase"
send "${12}\r"
expect eof
EOF
fi
echo 'SFTP Start'
# create a temporary file containing sftp commands
printf "%s" "put -r $5 $6" >$TEMP_SFTP_FILE
@ -104,11 +36,5 @@ printf "%s" "put -r $5 $6" >$TEMP_SFTP_FILE
sftp -b $TEMP_SFTP_FILE -P $3 $8 -o StrictHostKeyChecking=no -i $TEMP_SSH_PRIVATE_KEY_FILE $1@$2
echo 'Deploy Success'
# if passphrase is set stop ssh-agent after sftp connection
if [ -n "${12:-}" ]; then
echo 'Clear keys from ssh-agent'
# delete all keys from RAM
ssh-add -D
fi
exit 0

BIN
resource/keepformat.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 54 KiB