git_actions/SFTP-Deploy-Action
1
0 Fork 0
mirror of https://github.com/wlixcc/SFTP-Deploy-Action.git synced 2026-10-02 09:21:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: Add rsync filtering and optimize SFTP deployment process

Browse Source 
- Introduced rsync support with customizable `rsyncArgs` for file filtering.
- Ensured only filtered content is uploaded, avoiding `filtered_upload` folder inclusion.
- Updated documentation to reflect the latest changes and usage examples.
This commit is contained in:
wl committed 2024-12-31 11:39:56 +08:00
1 parent 89e97d73f9
commit 896dcfc555
5 files changed
+169 -84
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+116 -66
View File
@@ -1,114 +1,164 @@
# SFTP Deploy action
> Use this action to deploy your files to server using `SSH Private Key`
# SFTP Deploy Action
> 使用此`action`部署你的项目到服务器上，中文介绍链接：[使用Github Action 部署项目到云服务器](https://zhuanlan.zhihu.com/p/107545396)
> Use this action to deploy your files to a server using `SSH Private Key`
## 1. Inputs
> 使用此 `action` 部署你的项目到服务器上，中文介绍链接：[使用Github Action 部署项目到云服务器](https://zhuanlan.zhihu.com/p/107545396)
| 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 private key from your `ssh_private_key` 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.
<strike>args</strike> `sftpArgs` | no| | other args yor want to use of sftp, E.g.`-o ConnectTimeout=5`
`delete_remote_files` | no | false | Set to `true` will delete remote path folder and all files in it.
`password`| no| | SSH passsword，If a password is set, `ssh_private_key` is ignored. `for @v1.2.4 and greater`
---
> **Warning**
## 🚀 **1. Inputs**
> Be careful when use `delete_remote_files`, This will delete remote path folder and all files in it
| 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` 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)* |
-----
> ⚠️ **Warning:**
> Be careful when using `delete_remote_files`. This will **permanently delete** the remote path folder and all files in it **before** uploading.
## 2.Action Examples
---
## 📦 **2. Action Examples**
### **🔹 Basic Example**
```yaml
on: [push]
jobs:
deploy_job:
deploy_job:
runs-on: ubuntu-latest
name: deploy
name: Deploy Files
steps:
- name: Checkout
- name: Checkout
uses: actions/checkout@v2
- name: deploy file
uses: wlixcc/SFTP-Deploy-Action@v1.2.4
- name: Deploy to Server
uses: wlixcc/SFTP-Deploy-Action@v1.2.5
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'
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'
```
---
### **🔹 Example with rsyncArgs**
```yaml
on: [push]
jobs:
deploy_job:
deploy_job:
runs-on: ubuntu-latest
name: deploy
name: Deploy with rsync exclude
steps:
- name: Checkout
- name: Checkout
uses: actions/checkout@v2
- name: Deploy file
uses: wlixcc/SFTP-Deploy-Action@v1.2.4
- name: Deploy with Exclude Patterns
uses: wlixcc/SFTP-Deploy-Action@v1.2.5
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 }}
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'
```
## 3. [Deploy React App Example](https://github.com/wlixcc/React-Deploy)
---
### **🔹 Example with Password Authentication**
```yaml
on: [push]
jobs:
deploy_job:
deploy_job:
runs-on: ubuntu-latest
name: build&deploy
name: Deploy with Password
steps:
# To use this repository's private action, you must check out the repository
- name: Checkout
- name: Checkout
uses: actions/checkout@v2
- name: Install Dependencies
- name: Deploy with Password
uses: wlixcc/SFTP-Deploy-Action@v1.2.5
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 }}
```
---
## 🌐 **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
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Install Dependencies
run: yarn
- name: Build
- name: Build
run: yarn build
- name: deploy file to server
uses: wlixcc/SFTP-Deploy-Action@v1.2.4
- name: Deploy Build Folder
uses: wlixcc/SFTP-Deploy-Action@v1.2.5
with:
username: 'root'
server: '${{ secrets.SERVER_IP }}'
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
local_path: './build/*'
remote_path: '/var/www/react-app'
sftpArgs: '-o ConnectTimeout=5'
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'
```
![](./resource/reactExample.jpg)
--------
![](./resource/reactExample.jpg)
## 4.Invalid format? You need keep format
---
## 🛡️ **4. Invalid format? You need to keep the format**
If you use the **Ed25519** algorithm to generate an SSH key pair:
```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)
---
If you use the Ed25519 algorithm to generate an SSH key pair `ssh-keygen -t ed25519 -C "your_email@example.com"`,
you need to note that the last line of the private key is a blank line. You need to keep this line when adding Repository secrets, otherwise it may lead to an `invalid format` error.
![](./resource/keepformat.jpg)