FTP-Deploy-Action 使用教程

FTP-Deploy-Action 使用教程

项目介绍

FTP-Deploy-Action 是一个 GitHub Action，用于自动将代码部署到 FTP 服务器。它简化了将代码从 GitHub 仓库部署到远程服务器的流程，特别适合需要频繁更新和部署的项目。

项目快速启动

1. 创建 GitHub Actions 配置文件

在你的 GitHub 仓库根目录下创建一个 .github/workflows 目录，并在其中创建一个 YAML 文件，例如 deploy.yml。

2. 配置 FTP-Deploy-Action

在 deploy.yml 文件中添加以下内容：

name: Deploy to FTP

on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Deploy to FTP
        uses: SamKirkland/FTP-Deploy-Action@4.1.0
        with:
          server: ${{ secrets.FTP_SERVER }}
          username: ${{ secrets.FTP_USERNAME }}
          password: ${{ secrets.FTP_PASSWORD }}
          local-dir: ./
          server-dir: /public_html/

3. 配置 GitHub Secrets

在 GitHub 仓库的设置中，添加以下 Secrets：

• FTP_SERVER: FTP 服务器地址
• FTP_USERNAME: FTP 用户名
• FTP_PASSWORD: FTP 密码

4. 触发部署

每次向 main 分支推送代码时，GitHub Actions 将自动执行部署操作，将代码上传到指定的 FTP 服务器目录。

应用案例和最佳实践

应用案例

• 静态网站部署: 使用 FTP-Deploy-Action 可以轻松将静态网站部署到托管服务器。
• 持续集成/持续部署 (CI/CD): 结合 GitHub Actions，实现代码的自动构建和部署。

最佳实践

• 使用 Secrets 管理敏感信息: 避免在配置文件中直接写入敏感信息，使用 GitHub Secrets 进行管理。
• 选择合适的分支: 根据项目需求，选择合适的分支进行部署，例如 main 或 production。
• 定期更新 Action 版本: 定期检查并更新 FTP-Deploy-Action 的版本，以确保使用最新的功能和修复。

典型生态项目

• GitHub Actions: 作为 FTP-Deploy-Action 的运行环境，GitHub Actions 提供了强大的 CI/CD 功能。
• FTP 服务器: 任何支持 FTP 协议的服务器都可以作为部署目标，例如 Apache、Nginx 等。
• 静态网站生成器: 如 Jekyll、Hugo 等，生成静态网站后通过 FTP-Deploy-Action 部署到服务器。