GitHub Actions 自动化部署全攻略

name: Hello Actions  # 工作流的名字，在 GitHub 上会显示这里
on:                  # 触发器
  push:              # 当推送代码时触发
    branches:        # 只针对这些分支
      - main

jobs:                        # 作业
  greet:                     # 作业的名字，叫 greet（随意取）
    runs-on: ubuntu-latest   # 运行器：用 GitHub 提供的 Ubuntu

    steps:                          # 步骤
      - name: Checkout code         # 步骤名字（可选，但建议写，便于看日志）
        uses: actions/checkout@v4   # 使用动作：自动拉取代码

      - name: Say Hello             # 另一个步骤
        run: echo "Hello"           # 直接运行 shell 命令，打印一句话

name: Hello Test
on: push
jobs:
  hello:
    runs-on: ubuntu-latest
    steps:
      - run: echo "GitHub Actions 运行成功！"

# .github/workflows/ci-tests.yml
name: Run Tests
on:
  # 代码推送事件（main 或 develop 分支时触发）
  push:
    branches: [main, develop]
  # Pull Request事件（main 分支时触发）
  pull_request:
    branches: [main]
jobs:
  test:
    # 指定运行器为 ubuntu-latest
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v6
      # 配置 Node.js 环境（版本 24，启用 npm 缓存）
      - name: Setup Node.js
        uses: actions/setup-node@v6
        with:
          node-version: '24'
          cache: 'npm'
      - name: Install dependencies
        run: npm ci  # 执行命令
      - name: Run tests
        run: npm test

# .github/workflows/matrix-test.yml
name: Matrix Testing
on: [push, pull_request]  # 在代码推送或创建 PR 时触发
jobs:
  test:
    # 定义矩阵策略，生成多个并行任务
    strategy:
      matrix:
        node-version: [18, 20, 22, 24]  # 定义 Node.js 版本矩阵
        os: [ubuntu-latest, windows-latest, macos-latest]  # 定义操作系统矩阵
      fail-fast: false  # 一个组合失败不终止其他组合
    # 使用矩阵中的操作系统
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout code
        uses: actions/checkout@v6
      # 使用矩阵中的 Node.js 版本
      - name: Setup Node ${{ matrix.node-version }}
        uses: actions/setup-node@v6
        with:
          node-version: ${{ matrix.node-version }}
      - name: Install dependencies
        run: npm ci
      - name: Run tests
        run: npm test

# .github/workflows/custom-cache.yml
name: Cache Dependencies
on: [push, pull_request]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v6
      # 配置 Node.js 环境（不使用内置缓存）
      - name: Setup Node.js
        uses: actions/setup-node@v6
        with:
          node-version: '24'
      # 自定义缓存 node_modules 和 npm 全局缓存
      - name: Cache node_modules
        uses: actions/cache@v5
        with:
          path: |
            node_modules
            ~/.npm
          # 缓存键：基于 OS 和 package-lock.json 的哈希
          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
          # 恢复键：依赖变更时尝试匹配旧缓存
          restore-keys: |
            ${{ runner.os }}-node-
      - name: Install dependencies
        run: npm ci
      - name: Build project
        run: npm run build

# .github/workflows/artifact.yml
name: Build & Artifact
on: [push]
jobs:
  # build Job
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v6
      - name: Setup Node.js
        uses: actions/setup-node@v6
        with:
          node-version: '24'
      - name: Install & Build
        run: npm ci && npm run build
      # 上传构建产物（上传 dist/ 命名为 dist-files）
      - name: Upload artifact
        uses: actions/upload-artifact@v6
        with:
          name: dist-files
          path: dist/
  # deploy Job
  deploy:
    needs: build  # 依赖 build Job（必须等其完成后执行）
    runs-on: ubuntu-latest
    steps:
      # 下载构建产物（名称为 dist-files）
      - name: Download artifact
        uses: actions/download-artifact@v6
        with:
          name: dist-files
      - name: List files
        run: ls -R  # 递归列出当前目录下所有文件和子目录

# .github/workflows/job-outputs.yml
name: Job Outputs
on: [push]
jobs:
  create-data:
    runs-on: ubuntu-latest
    # 声明要输出的变量 current_time
    outputs:
      current_time: ${{ steps.get-time.outputs.time }}  # 此处 time 对应 '当前时间是 $(date)'
    steps:
      - name: Get current time
        id: get-time  # 给这个步骤起个 ID，方便后面引用
        run: echo "time=当前时间是 $(date)" >> $GITHUB_OUTPUT  # >> $GITHUB_OUTPUT：把结果保存为这个步骤的输出
  use-data:
    needs: create-data
    runs-on: ubuntu-latest
    steps:
      - name: Print time
        run: echo "打印接收到的时间：${{ needs.create-data.outputs.current_time }}"

# .github/workflows/manual-deploy.yml
name: Manual Deploy
on:
  # 启用手动触发
  workflow_dispatch:
    # 自定义输入项
    inputs:
      # env（部署环境）选择器，可选 staging 和 production
      env:
        type: choice
        description: 部署环境
        options: [staging, production]
        default: staging
      # version（版本号）输入框
      version:
        type: string
        description: 版本号
        default: latest
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v6
      # 部署测试环境
      - name: Deploy Staging
        if: github.event.inputs.env == 'staging'
        run: echo "Deploy staging ${{ github.event.inputs.version }}"
      # 部署生产环境
      - name: Deploy Production
        if: github.event.inputs.env == 'production'
        run: echo "Deploy production ${{ github.event.inputs.version }}"

# .github/workflows/schedule.yml
name: Scheduled Task
on:
  # 定时触发器，使用 cron 语法
  schedule:
    - cron: '0 3 * * *'  # UTC 每天 3:00（北京 11:00）
  workflow_dispatch:  # 方便手动测试
jobs:
  nightly:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v6
      - name: Setup Node.js
        uses: actions/setup-node@v6
        with:
          node-version: '24'
      - name: Install dependencies
        run: npm ci
      - name: Check outdated dependencies
        run: npm outdated || echo "所有依赖均为最新"
      - name: Run security audit
        run: npm audit || echo "安全检查完成"

# .github/workflows/docker-publish.yml
name: Docker Publish
on:
  push:
    tags: ['v*']  # v* 标签（如 v1.0.0）时触发
jobs:
  docker:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v6
      # 登录 Docker Hub
      - name: Login Docker
        uses: docker/login-action@v3
        with:
          username: ${{ secrets.DOCKER_USERNAME }}  # Docker Hub 用户名
          password: ${{ secrets.DOCKER_TOKEN }}     # Docker Hub 生成的 Access Token
      # 构建并推送镜像
      - name: Build and push
        uses: docker/build-push-action@v6
        with:
          push: true  # 推送镜像
          tags: |     # 多标签推送
            ${{ secrets.DOCKER_USERNAME }}/myapp:latest
            ${{ secrets.DOCKER_USERNAME }}/myapp:${{ github.ref_name }}

# .github/workflows/deploy-server.yml
name: Deploy Server
on: [push]
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v6
      - name: Setup Node.js
        uses: actions/setup-node@v6
        with:
          node-version: '24'
      - name: Install dependencies
        run: npm ci
      - name: Build project
        run: npm run build
      # 通过 SSH 上传文件到服务器（使用 rsync 同步）
      - name: Deploy to server
        uses: easingthemes/ssh-deploy@v5
        env:
          SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}  # SSH 私钥
          REMOTE_HOST: ${{ secrets.SSH_HOST }}             # 服务器 IP 或域名
          REMOTE_USER: ${{ secrets.SSH_USERNAME }}         # 登录用户名（不建议 root）
          SOURCE: "dist/"                                  # 要上传的目录
          TARGET: ${{ secrets.TARGET_PATH }}               # 服务器目标目录
          ARGS: "-avzr --delete"                           # rsync 参数：压缩、递归、删除多余文件

# 模板仓库：.github/workflows/reusable-test.yml
name: Reusable Test Workflow
on:
  workflow_call:  # 关键：表示这是可被调用的工作流
    inputs:       # 定义输入参数
      node-version:
        required: true
        type: string
      cache-enabled:
        type: boolean
        default: true
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: Setup Node.js
        uses: actions/setup-node@v6
        with:
          node-version: ${{ inputs.node-version }}
          cache: ${{ inputs.cache-enabled && 'npm' || '' }}
      - run: npm ci
      - run: npm test

# 项目仓库：.github/workflows/ci.yml
name: Call Reusable Test
on: [push, pull_request]
jobs:
  call-test:
    uses: [用户名、组织名]/[模板仓库]/.github/workflows/reusable-test.yml@main  # 调用路径
    with:  # 传入参数
      node-version: '24'
      cache-enabled: true

jobs:
  deploy-prod:
    environment: production  # 指定环境，触发保护规则
    runs-on: ubuntu-latest
    steps:
      # 环境专属 Secrets 自动可用
      - run: deploy-script --token ${{ secrets.PROD_TOKEN }}

jobs:
  heavy-build:
    runs-on: self-hosted  # 自托管运行器
    steps:
      - run: ./heavy-computation