在 Azure DevOps CI 管道中如何检查是否忘记在 EF Core 3 中添加迁移

35次阅读

问题描述

在使用 Azure DevOps 构建一个使用 EF Core 3 的 .NET Core 3 项目的 CI 管道时，希望找到一种方法来检查开发人员在修改系统模型后是否忘记执行 Add-Migration 命令。
用户考虑过通过执行 Add-Migration temp 命令并检查生成的文件中是否存在 Up 或 Down 步骤来实现，但还不确定如何实现。用户想知道是否有更好的方法来解决这个问题。

解决方案

请注意以下操作注意版本差异及修改前做好备份。

方案1

你可以使用 EF Core 的命令行工具来检查是否有未应用的迁移。EF Core 提供了一个名为 ef 的命令行工具，可以用于管理数据库迁移。
以下是在 Azure DevOps CI 管道中如何使用 EF Core 命令行工具来检查是否有未应用的迁移的步骤：
1. 在 Azure DevOps CI 管道中添加一个步骤，用于执行 dotnet ef migrations list 命令。这个命令将列出所有已应用和未应用的迁移。
2. 解析命令的输出，检查是否有未应用的迁移。你可以使用一些脚本或工具来解析命令的输出，并根据需要执行相应的操作。
下面是一个示例的 Azure DevOps CI 管道配置文件：

trigger:
  branches:
    include:
      - master

jobs:
- job: CheckMigrations
  displayName: 'Check for missing migrations'
  pool:
    vmImage: 'ubuntu-latest'
  steps:
  - task: UseDotNet@2
    displayName: 'Use .NET Core sdk 3.x'
    inputs:
      packageType: 'sdk'
      version: '3.x'
  - script: |
      dotnet tool install --global dotnet-ef
      dotnet ef migrations list
    displayName: 'Check for missing migrations'

在上面的示例中，我们首先使用 UseDotNet 任务来安装 .NET Core 3.x SDK。然后，我们使用 dotnet tool install 命令来安装 EF Core 命令行工具。最后，我们使用 dotnet ef migrations list 命令来列出所有已应用和未应用的迁移。
你可以根据需要进一步处理命令的输出，例如使用脚本或工具来解析输出并执行相应的操作。

方案2

使用脚本或工具来检查未应用的迁移可能会增加复杂性，并且需要确保脚本或工具的正确性。
另一种方法是编写脚本或使用工具来检查是否有未应用的迁移。你可以使用一些脚本或工具来执行 Add-Migration 命令，并检查生成的文件中是否存在 Up 或 Down 步骤。
以下是一个简单的 PowerShell 脚本示例，可以在 Azure DevOps CI 管道中使用：

# 安装 EF Core 工具
dotnet tool install --global dotnet-ef

# 执行 Add-Migration 命令
dotnet ef migrations add temp

# 检查生成的文件是否包含 Up 或 Down 步骤
$hasSteps = Select-String -Path ./Migrations/*.cs -Pattern "Up\(\)" -or "Down\(\)"
if ($hasSteps) {
    Write-Host "There are migration steps."
} else {
    Write-Host "There are no migration steps."
}

在这个示例中，我们首先使用 dotnet tool install 命令来安装 EF Core 工具。然后，我们使用 dotnet ef migrations add temp 命令执行 Add-Migration 命令，并生成一个临时的迁移文件。最后，我们使用 Select-String 命令来检查生成的文件中是否包含 Up 或 Down 步骤。
你可以根据需要进一步处理脚本的输出，并执行相应的操作。
请注意，使用脚本或工具来检查未应用的迁移可能会增加复杂性，并且需要确保脚本或工具的正确性。因此，方案1中使用 EF Core 命令行工具可能更简单和可靠。

正文完