自动化部署流程_使用GitHub Actions的配置

自动化部署通过GitHub Actions实现CI/CD,1. 创建.yml工作流文件定义步骤;2. 使用SSH密钥安全传输文件至服务器;3. 按分支设置触发条件区分环境;4. 添加缓存与错误处理提升效率。

自动化部署能极大提升开发效率,减少人为操作失误。使用 GitHub Actions 可以在代码提交或合并后自动完成测试、构建和部署,实现持续集成与持续部署(CI/CD)。以下是基于 GitHub Actions 实现自动化部署的配置方法。

1. 创建 GitHub Actions 工作流文件

GitHub Actions 的工作流由 YAML 文件定义,存放在项目根目录下的 .github/workflows 文件夹中。创建一个如 deploy.yml 的文件来配置流程。

基本结构如下:

name: Deploy Application

on: push: branches:

  • main

jobs: deploy: runs-on: ubuntu-latest steps:

  • name: Checkout code uses: actions/checkout@v4

  • name: Set up Node.js uses: actions/setup-node@v3 with: node-version: '18'

  • name: Install dependencies run: npm install

  • name: Build project run: npm run build

  • name: Deploy to server run: | echo "Deploying files..."

    这里填写具体的部署命令

2. 配置部署方式(以 SSH 部署为例)

若需将构建后的文件发送到远程服务器,可通过 SSH 执行。先在项目的 Settings > Secrets and variables > Actions 中添加以下密钥:

  • SSH_HOST:服务器地址
  • SSH_USER:登录用户名
  • SSH_KEY:私钥内容(建议使用专用部署密钥)
  • DEPLOY_PATH:服务器上目标路径

然后在工作流中使用 appleboy/scp-actionappleboy/ssh-action 完成文件传输与命令执行:

      - name: Copy files via SCP
        uses: appleboy/scp-action@v0.1.5
        with:
          host: ${{ secrets.SSH_HOST }}
          username: ${{ secrets.SSH_USER }}
          key: ${{ secrets.SSH_KEY }}
          source: "dist/"
          target: ${{ secrets.DEPLOY_PATH }}
  - name: Restart service on server
    uses: appleboy/ssh-action@v0.1.10
    with:
      host: ${{ secrets.SSH_HOST }}
      username: ${{ secrets.SSH_USER }}
      key: ${{ secrets.SSH_KEY }}
      script: |
        cd ${{ secrets.DEPLOY_PATH }}
        npm install
        pm2 restart app || pm2 start app.js

3. 设置触发条件与环境控制

可以根据分支、标签或事件类型精确控制何时触发部署:

  • 仅在 main 分支推送时部署生产环境
  • preview 分支推送时部署预览环境
  • 通过 if 条件判断执行不同流程

示例:

on:
  push:
    branches:
      - main
      - preview

jobs: deploy-production: if: github.ref == 'refs/heads/main' runs-on: ubuntu-latest

... 步骤同上,指向生产路径

deploy-preview: if: github.ref == 'refs/heads/preview' runs-on: ubuntu-latest

... 指向预览服务器

4. 添加缓存与错误处理

提升执行效率,避免重复安装依赖:

      - name: Cache dependencies
        uses: actions/cache@v3
        with:
          path: ~/.npm
          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-node-

同时建议加入通知机制(如企业微信、钉钉、邮件)或使用 continue-on-error 控制关键步骤失败时的行为。

基本上就这些。合理配置后,每次提交代码都能自动走完测试到上线全过程,省时又可靠。不复杂但容易忽略的是权限和密钥安全,务必限制部署密钥的访问范围。