仅在项目已更改时创建 Nuget 包

Question

给定一个包含 Web Api 项目、Api 客户端项目和包含共享 Dto 对象的程序集项目的解决方案，如下所示：

• 解决方案
  • Web API 项目
  • 共享 Dto 项目
  • API 客户端项目
  • 单元测试

我有一个 Azure Devops 构建管道来构建和测试所有项目。 在该构建管道中，我有一个步骤为 Api 客户端和共享 Dto 项目创建 2 个 Nuget 包。

但是，我不需要一直创建新包，比如说我只是在 Web Api 项目中添加了一个单元测试或修复了一个错误，我不想创建新的 Nuget 包（或者担心如果 Api 客户端项目（或其依赖项）中没有任何变化，但我仍然想对其进行回归测试。

我想也许我可以通过多个构建管道来做到这一点，一个用于 Web Api 项目，另一个用于 Api 客户端和共享项目，然后使用路径过滤器来触发适当的构建。

还有其他方法可以实现吗？ 最佳做法是什么？ 我不想维护比我需要的更多的构建定义。

Answer 1

还有其他方法可以实现吗？最佳做法是什么？我不想维护比我需要的更多的构建定义。

有不同的方法来实现它，但不确定哪一种是最佳实践，这完全取决于您的要求或品味。

简单方法与你的想法类似。还需要创建一个新的构建管道。不同的是我们不需要维护这个构建定义。

详情：

• 在此管道中添加一个没有任何其他任务的新管道，并使用 path 过滤器以触发适当的构建（Api 客户端和 共享 Dto 项目）。
• 向您的原始 Azure Devops 构建管道添加 构建完成：

• 为基于Build.Reason 创建 2 个 Nuget 包的步骤添加 custom condition，例如：

  and(succeeded(), eq(variables['Build.Reason'], 'BuildCompletion'))
  

现在，创建 2 个 Nuget 包的步骤仅在文件更改来自特定项目时执行。当然，这个解决方案的局限性在于，如果你已经有一个构建完成，它将无法工作。

如果上述方法不是您想要的，我们可以调用 REST API commits 来获取每个构建的提交信息：

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commits/{commitId}?changeCount=100&api-version=5.1

我们可以在返回的正文中找到更改/路径：

  "changes": [
    {
      "item": {
        "gitObjectType": "blob",
        "path": "/.gitattributes",
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/.gitattributes?versionType=Commit"
      },
      "changeType": "add"
    },
    {
      "item": {
        "gitObjectType": "blob",
        "path": "/.gitignore",
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/.gitignore?versionType=Commit"
      },
      "changeType": "add"
    },
    {
      "item": {
        "gitObjectType": "tree",
        "path": "/MyWebSite",
        "isFolder": true,
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/items/MyWebSite?versionType=Commit"
      },
      "changeType": "add"
    },

然后我们可以使用 powershell 脚本遍历这些路径，看看它们是否包含 Api Client 和 Shared Dto 项目，如果是，我们设置一个带有值的变量，根据这个值为创建 2 的步骤添加条件Nuget 包。

注意：在使用 REST API commits 之前，我们需要使用 Commits - Get Commits 来获取最新的提交 ID：

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commits?$top=1&api-version=5.1

希望这会有所帮助。

Answer 2

我最终对 this answer

# Checks which files have been updated to determine if new Nuget packages are required
$editedFiles = git diff HEAD HEAD~ --name-only
echo "$($editedFiles.Length) files modified:"
$editedFiles | ForEach-Object {
   echo $_
    Switch -Wildcard ($_ ) {
        'Whds.Configuration.Models/*' { 
              # If the Models project is updated, we need to create both packages
              Write-Output "##vso[task.setvariable variable=CreateModelsPackage]True"
              Write-Output "##vso[task.setvariable variable=CreateClientPackage]True"  
         }        
        'Whds.Configuration.Standard/*' { Write-Output "##vso[task.setvariable 
variable=CreateClientPackage]True" }
        # The rest of your path filters
    }
}

此脚本设置变量，然后在构建管道的 dotnet pack 步骤中的自定义条件中引用这些变量：

and(succeeded(), eq(variables['CreateModelsPackage'], 'True'))

如果更改 Dto 项目，则设置两个变量以创建两个包。 如果只有客户端（也称为标准）项目是唯一更改的项目，则不会创建 Dto 项目的包。