GitHub Actions 入门指南

✨文章摘要（AI生成） GitHub Actions 是 GitHub 提供的自动化工具，允许你在代码仓库中直接创建、测试、部署代码的自动化流程。本指南从基础概念到实战示例，手把手教你配置第一个自动化工作流。

一、核心概念解析

1.1 基础术语

• Workflow（工作流） 自动化流程的配置文件（YAML 格式），存放在 .github/workflows 目录下，每个文件对应一个独立的工作流。

• Job（作业） 一个工作流由多个作业组成，默认并行执行（可通过 needs 关键字配置依赖关系实现串行）。

• Step（步骤） 每个作业包含多个步骤，按顺序执行。步骤可以是：

  • Shell 命令（run）
  • 调用预定义动作（uses）
  • 自定义脚本

• Action（动作） 可复用的代码单元（如检出代码、发送通知），可通过 GitHub Marketplace 获取现成动作。

1.2 文件结构示意

你的项目/
├── .github/
│   └── workflows/
│       ├── ci.yml     # 持续集成工作流
│       └── deploy.yml # 部署工作流
└── src/              # 项目源代码

二、创建第一个工作流

2.1 配置示例

在项目根目录创建 .github/workflows/first-workflow.yml：

# 工作流名称（显示在Actions页面）
name: My First Workflow

# 触发条件：当代码推送到任意分支时触发
on: [push]

jobs:
  # 作业ID（自定义名称）
  build-job:
    # 运行环境（可选：ubuntu-latest/windows-latest/macos-latest）
    runs-on: ubuntu-latest
    
    # 步骤集合
    steps:
      # 步骤1：检出代码（必须的第一步）
      - name: Checkout repository
        uses: actions/checkout@v4  # 使用官方提供的代码检出动作

      # 步骤2：自定义命令
      - name: Greeting
        run: |  # 执行多行命令
          echo "🎉 GitHub Actions 已启动！"
          echo "当前时间: $(date)"

2.2 执行流程说明

1. 推送代码到 GitHub 仓库
2. 进入仓库的 Actions 标签页
3. 选择左侧的 "My First Workflow"
4. 查看实时执行日志（点击具体运行记录）

三、常用触发机制

3.1 事件触发

on:
  # 当创建新标签时触发
  create_tag:
  
  # 当合并PR到main分支时触发
  pull_request:
    branches: [main]
  
  # 当issue被关闭时触发
  issues:
    types: [closed]

3.2 定时触发

on:
  schedule:
    # 每天北京时间8点运行（UTC时间0点）
    - cron: '0 0 * * *'
    # 每周一9:30运行
    - cron: '30 9 * * 1'

3.3 手动触发

on:
  workflow_dispatch:
    inputs:
      environment:
        description: '部署环境'
        required: true
        default: 'staging'

四、典型应用场景

4.1 Node.js 项目自动化测试

jobs:
  test:
    name: 🧪 Node.js 测试套件
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      # 设置Node.js环境
      - name: 配置Node.js环境 ⚙️
        uses: actions/setup-node@v3
        with:
          node-version: 18  # 指定LTS版本
          cache: 'npm'      # 启用npm缓存加速后续构建

      # 安装依赖
      - name: 安装项目依赖 📦
        run: npm ci  # 使用clean install保证依赖一致性
      
      # 运行测试
      - name: 执行单元测试 ✅
        run: npm test
      
      # 生成覆盖率报告
      - name: 生成覆盖率报告 📊
        run: npm run coverage
      
      # 上传测试结果
      - name: 归档测试结果 📁
        uses: actions/upload-artifact@v3
        with:
          name: test-results
          path: |
            test-results/
            coverage/

4.2 多环境构建部署

jobs:
  build:
    name: 🏗️ 构建项目
    runs-on: ubuntu-latest
    outputs:
      build-info: ${{ steps.meta.outputs.result }}
    steps:
      - uses: actions/checkout@v4
      
      - name: 编译生产版本 🔨
        run: |
          npm install
          npm run build
          
      # 生成构建元数据
      - name: 生成构建信息 ℹ️
        id: meta
        run: |
          echo "result=build-success-$(date +%s)" >> $GITHUB_OUTPUT
      
      - name: 上传构建产物 📤
        uses: actions/upload-artifact@v3
        with:
          name: production-build
          path: dist/

  deploy:
    name: 🚀 部署到生产环境
    needs: build
    runs-on: ubuntu-latest
    environment: production
    steps:
      - name: 下载构建产物 📥
        uses: actions/download-artifact@v3
        with:
          name: production-build
          
      - name: SSH安全部署 🔒
        env:
          SSH_KEY: ${{ secrets.DEPLOY_SSH_KEY }}  # 从仓库机密读取SSH密钥
        run: |
          scp -i $SSH_KEY -r . user@server:/var/www

五、进阶配置技巧

5.1 密钥管理

- name: 安全部署应用 🔐
  env:
    API_TOKEN: ${{ secrets.API_KEY }}  # 使用仓库存储的机密凭证
  run: |
    curl -H "Authorization: Bearer $API_TOKEN" ...

5.2 矩阵策略（多版本测试）

jobs:
  test:
    name: 🔄 多版本兼容性测试
    strategy:
      matrix:
        node-version: [14.x, 16.x, 18.x]  # 测试主流Node版本
        os: [ubuntu-latest, windows-latest]  # 跨平台验证
    runs-on: ${{ matrix.os }}
    steps:
      - uses: actions/checkout@v4
      
      - name: 配置Node环境 ⚙️
        uses: actions/setup-node@v3
        with:
          node-version: ${{ matrix.node-version }}  # 动态获取矩阵版本
          
      - name: 执行自动化测试 🧪
        run: npm test

六、学习资源推荐

1. 官方文档
   GitHub Actions 官方指南 - 最权威的参考资料

2. 实战案例库
   GitHub Actions Examples - 官方示例仓库

3. 调试工具
   GitHub Actions 调试工具 - 本地运行工作流

4. 安全指南
   安全加固指南 - 避免常见安全隐患

5. 阮一峰的网络日志
   GitHub Actions 入门教程 - 阮一峰的网络日志