Ent项目持续集成(CI)实践指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00504/article/details/148376029

Ent项目持续集成(CI)实践指南

ent 项目地址: https://gitcode.com/gh_mirrors/ent4/ent

什么是持续集成(CI)

持续集成(Continuous Integration)是现代软件开发中确保代码质量的重要实践。通过CI流程，开发团队可以在每次代码变更时自动运行一系列验证检查，包括但不限于：

代码编译验证
代码风格检查
单元测试执行
安全风险扫描

对于使用Ent框架的项目，实施专门的CI检查尤为重要，因为Ent高度依赖代码生成机制。

Ent项目CI检查要点

1. 验证生成的代码是否提交

Ent框架通过代码生成机制创建了大量辅助代码。最佳实践要求将这些生成代码一并提交到代码仓库中，原因有二：

代码可读性：生成的代码与业务代码一起审查，有助于全面理解系统行为
环境一致性：避免"在我机器上能运行"的问题，确保团队成员使用相同代码

实现方案

方案一：使用专用CI工具

# 配置文件示例
name: EntCI
on:
  push:
    branches: [ master ]
  pull_request:
    paths: [ 'ent/*' ]
jobs:
  ent:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3.0.1
      - uses: actions/setup-go@v3
        with:
          go-version: 1.18
      - uses: ent/contrib/ci@master

方案二：使用Bash脚本

go generate ./...
status=$(git status --porcelain)
if [ -n "$status" ]; then
    echo "请先执行'go generate ./...'并提交变更"
    echo "$status"
    exit 1
fi

2. 数据库迁移文件检查

当Ent项目使用版本化迁移管理数据库变更时，CI流程中应包含迁移文件检查：

SQL语法验证：确保所有SQL语句语法正确且顺序合理
迁移完整性：检查历史记录是否被意外修改
破坏性变更检测：提前发现可能导致数据丢失的操作
数据依赖检查：识别可能在部署时失败的变更

实现方案

以MySQL为例的配置示例：

name: Atlas CI
on:
  push:
    branches: [ master ]
  pull_request:
    paths: [ 'ent/migrate/migrations/*' ]
jobs:
  lint:
    services:
      mysql:
        image: mysql:8.0.29
        env:
          MYSQL_ROOT_PASSWORD: pass
          MYSQL_DATABASE: test
        ports: [ 3306:3306 ]
        options: >-
          --health-cmd "mysqladmin ping -ppass"
          --health-interval 10s
          --health-start-period 10s
          --health-timeout 5s
          --health-retries 10
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3.0.1
        with:
          fetch-depth: 0
      - uses: ariga/atlas-action@v0
        with:
          dir: ent/migrate/migrations
          dir-format: golang-migrate
          dev-url: mysql://root:pass@localhost:3306/test