github-actions-workflow

GitHub Actions 工作流

目录

• 概览
• 适用场景
• 快速入门
• 参考指南
• 最佳实践

概览

直接从 GitHub 仓库创建强大的 GitHub Actions 工作流，自动执行测试、构建、安全扫描和部署流程。

适用场景

• 持续集成和测试
• 构建自动化
• 安全扫描和分析
• 依赖更新
• 自动部署
• 发布管理
• 代码质量检查

快速入门

最简可运行示例：

# .github/workflows/ci.yml
name: CI/CD Pipeline

on:
  push:
    branches: [main, develop]
  pull_request:
    branches: [main, develop]

env:
  REGISTRY: ghcr.io
  IMAGE_NAME: ${{ github.repository }}

jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [16.x, 18.x, 20.x]
    steps:
      - uses: actions/checkout@v3

      - name: Setup Node ${{ matrix.node-version }}
        uses: actions/setup-node@v3
        with:
// ... (see reference guides for full implementation)

参考指南

references/ 目录中的详细实现：

指南	内容
完整 CI/CD 工作流	完整 CI/CD 工作流
自动发布工作流	自动发布工作流
Docker 构建和推送	Docker 构建和推送

最佳实践

✅ 应该做

• 使用缓存处理依赖项（npm、pip、Maven）
• 使用矩阵策略并行运行测试
• 在受保护的分支上要求通过状态检查
• 使用环境机密和变量
• 使用 if: 实现条件作业
• 在测试前执行 lint 和格式化
• 使用 permissions 明确设置权限
• 使用运行器标签指定硬件
• 缓存 Docker 层以加快构建

❌ 不应该做

• 在工作流文件中存储机密
• 在工作流中运行不受信任的代码
• 对来自 fork 的拉取请求使用 secrets.*
• 硬编码凭据或令牌
• 忽略 continue-on-error 的错误处理
• 创建过于复杂的工作流
• 跳过拉取请求中的测试