使用 GitHub Action 进行 SSH 部署

项目介绍

ssh-deploy 是一个 GitHub Action，用于通过 rsync 和 SSH 部署代码。它支持在 rsync 之前或之后执行远程脚本，并且使用 NodeJS 版本比简单的 Docker 版本快一分钟以上。这个 Action 通常在构建/测试步骤之后使用，将可部署的代码（例如 dist 目录）从 GITHUB_WORKSPACE 部署到服务器上的目标目录。

项目快速启动

1. 克隆项目

首先，克隆 ssh-deploy 项目到本地：

git clone https://github.com/easingthemes/ssh-deploy.git
cd ssh-deploy

2. 配置 GitHub Action

在你的 GitHub 仓库中，创建一个新的 GitHub Action 配置文件 .github/workflows/deploy.yml，并添加以下内容：

name: Deploy to Staging server

on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Install Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '16.x'
      - name: Install npm dependencies
        run: npm install
      - name: Run build task
        run: npm run build --if-present
      - name: Deploy to Server
        uses: easingthemes/ssh-deploy@main
        with:
          SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
          ARGS: "-rlgoDzvc -i --delete"
          SOURCE: "dist/"
          REMOTE_HOST: ${{ secrets.REMOTE_HOST }}
          REMOTE_USER: ${{ secrets.REMOTE_USER }}
          TARGET: ${{ secrets.REMOTE_TARGET }}
          EXCLUDE: "/dist/ /node_modules/"
          SCRIPT_BEFORE: |
            whoami
            ls -al
          SCRIPT_AFTER: |
            whoami
            ls -al
            echo $RSYNC_STDOUT

3. 配置 Secrets

在 GitHub 仓库的 Settings -> Secrets 中添加以下 Secrets：

• SSH_PRIVATE_KEY: 你的 SSH 私钥
• REMOTE_HOST: 远程服务器地址
• REMOTE_USER: 远程服务器用户名
• REMOTE_TARGET: 远程服务器目标目录

4. 提交并触发部署

提交并推送你的更改到 main 分支，GitHub Action 将自动触发部署流程。

应用案例和最佳实践

应用案例

ssh-deploy 适用于需要频繁部署代码到远程服务器的场景，例如：

• Web 应用程序的持续集成和部署
• 静态网站的自动部署
• 微服务的自动化部署

最佳实践

1. 使用 SSH 密钥对: 为了提高安全性，建议使用 SSH 密钥对进行身份验证，而不是密码。
2. 配置 rsync 参数: 根据你的需求配置 ARGS 参数，以确保 rsync 的行为符合预期。
3. 脚本执行: 在 SCRIPT_BEFORE 和 SCRIPT_AFTER 中添加必要的脚本，以确保在部署前后执行必要的操作。

典型生态项目

ssh-deploy 可以与其他 GitHub Actions 和工具结合使用，形成完整的 CI/CD 流水线。以下是一些典型的生态项目：

1. actions/checkout: 用于检出代码库。
2. actions/setup-node: 用于设置 Node.js 环境。
3. actions/cache: 用于缓存 npm 依赖，加快构建速度。
4. actions/upload-artifact: 用于在多个步骤之间共享构建产物。

通过结合这些工具，你可以构建一个高效、自动化的部署流程。