GitHub Actions 完全指南：从零到自动化部署

# .github/workflows/ci.yml

name: CI Pipeline  # workflow 名称

on:  # 触发事件
  push:
    branches: [ main, develop ]
  pull_request:
    branches: [ main ]

jobs:  # 定义任务
  build:
    runs-on: ubuntu-latest  # 运行环境
    steps:  # 步骤
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '18'

      - name: Install dependencies
        run: npm install

      - name: Run tests
        run: npm test

on:
  push:
    branches:
      - main
    paths:
      - 'src/**'
      - 'package.json'
      - '.github/workflows/**'
    paths-ignore:
      - 'docs/**'
      - '*.md'

on:
  push:
    tags:
      - 'v*'  # 匹配 v1.0、v2.1.3 等

jobs:
  build:
    name: Build and Test
    runs-on: ubuntu-latest
    timeout-minutes: 30  # 超时时间
    continue-on-error: false  # 出错是否继续

    steps:
      - name: Step 1
        run: echo "Hello"

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - run: npm test

  build:
    runs-on: ubuntu-latest
    steps:
      - run: npm run build

  lint:
    runs-on: ubuntu-latest
    steps:
      - run: npm run lint

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - run: npm test

  build:
    runs-on: ubuntu-latest
    needs: test  # 等待 test job 完成
    steps:
      - run: npm run build

  deploy:
    runs-on: ubuntu-latest
    needs: [test, build]  # 等待多个 job
    steps:
      - run: npm run deploy

runs-on: self-hosted  # 使用自托管 runner

# 或指定标签
runs-on: [self-hosted, linux, x64]

steps:
  # 使用 GitHub 官方 action
  - name: Checkout
    uses: actions/checkout@v4

  # 使用社区 action（指定版本）
  - name: Setup Node.js
    uses: actions/setup-node@v4
    with:
      node-version: '18'
      cache: 'npm'

  # 使用 Docker 容器 action
  - name: Run in Docker
    uses: docker://alpine:latest

steps:
  - name: Run shell command
    run: echo "Hello, World!"

  # 多行命令
  - name: Multi-line command
    run: |
      echo "Line 1"
      echo "Line 2"
      npm install
      npm test

  # 指定 shell
  - name: PowerShell script
    shell: pwsh
    run: Write-Host "Hello from PowerShell"

  # 工作目录
  - name: Build in subdir
    working-directory: ./src
    run: npm run build

jobs:
  build:
    runs-on: ubuntu-latest
    env:
      NODE_ENV: production
      API_KEY: ${{ secrets.API_KEY }}  # 从 secrets 读取

    steps:
      - name: Print env
        run: echo $NODE_ENV
        env:
          LOCAL_VAR: local_value  # step 级别的环境变量

jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [14, 16, 18]
        os: [ubuntu-latest, windows-latest]
        include:
          - os: macos-latest
            node-version: 18
        exclude:
          - os: windows-latest
            node-version: 14

    steps:
      - uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: ${{ matrix.node-version }}

      - name: Run tests
        run: npm test

steps:
  - uses: actions/checkout@v4

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

  - name: Install dependencies
    run: npm ci

steps:
  - name: Build
    run: npm run build

  - name: Upload artifacts
    uses: actions/upload-artifact@v3
    with:
      name: build-output
      path: dist/
      retention-days: 7  # 保留天数（默认 90）

steps:
  - name: Download artifacts
    uses: actions/download-artifact@v3
    with:
      name: build-output
      path: dist/

steps:
  - name: Deploy to server
    run: |
      echo "Deploying with API key: ${{ secrets.API_KEY }}"
      curl -H "Authorization: Bearer ${{ secrets.API_KEY }}" ...

name: Deploy to Server

on:
  push:
    branches: [ main ]

jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Deploy via SSH
        uses: appleboy/ssh-action@v1.0.0
        with:
          host: ${{ secrets.SERVER_HOST }}
          username: ${{ secrets.SERVER_USER }}
          key: ${{ secrets.SSH_PRIVATE_KEY }}
          script: |
            cd /var/www/app
            git pull origin main
            docker-compose restart

name: Build and Push Docker Image

on:
  push:
    tags: [ 'v*' ]

jobs:
  docker:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Login to Docker Hub
        uses: docker/login-action@v2
        with:
          username: ${{ secrets.DOCKER_USERNAME }}
          password: ${{ secrets.DOCKER_PASSWORD }}

      - name: Build and push
        uses: docker/build-push-action@v4
        with:
          context: .
          push: true
          tags: myapp:latest,myapp:${{ github.ref_name }}

jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Setup kubectl
        uses: azure/setup-kubectl@v3
        with:
          version: 'latest'

      - name: Configure kubeconfig
        run: |
          echo "${{ secrets.KUBE_CONFIG }}" > ~/.kube/config
          chmod 600 ~/.kube/config

      - name: Deploy to K8s
        run: |
          kubectl set image deployment/myapp myapp=myapp:${{ github.sha }}
          kubectl rollout status deployment/myapp

# 检查项：
1. workflow 文件是否在 .github/workflows/ 目录下
2. 文件名是否以 .yml 或 .yaml 结尾
3. YAML 语法是否正确（可用 yamllint 检查）
4. on 触发条件是否匹配当前事件

# 使用镜像加速
steps:
  - name: Setup Node.js
    uses: actions/setup-node@v4
    with:
      node-version: '18'
      registry-url: 'https://registry.npmmirror.com'

# 某些操作需要设置权限
permissions:
  contents: read
  packages: write

environment:
  name: production
  url: https://prod.example.com