Azure DevOps：使用 DevOps API 覆盖 YAML 持续集成触发器

Question

我们希望自动化构建管道，并且应该在特定分支上的每次提交时触发它。 有一种方法可以覆盖 yaml 文件（参见图片）并设置分支过滤器。 但是有没有办法用 API 来做同样的事情呢？

我尝试更新管道定义。 目标是让 JSON 文件看起来像通过 Web 界面手动创建的文件，以设置分支过滤器。 我成功了，但是当我发送后请求并更新网页时，设置了“禁用持续集成”处的勾号，并且再次调用 JSON 后，JSON 文件中的关键“触发器”不再存在。

$apiVersion = "6.0"
$Organization = "Orga" 
$Project = "TestProject"
$PipelineId = "42"
$token = "PAT"

$authorization = [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes(":$token"))

$request = "https://dev.azure.com/$($Organization)/$($Project)/_apis/build/definitions/$($PipelineId)?api-version=$($apiVersion)"
$json = Invoke-WebRequest -Uri $request -Method Get -Headers @{Authorization = "Basic $authorization" } -ContentType "application/json" | ConvertFrom-Json

#set Branch Filter
$defaultBranch = "folder/branchName"
$branchFilters += @("+refs/heads/$($defaultBranch)")
$json.triggers[0].branchFilters = $branchFilters

#Delete Key: "settingsSourceType"
$json.triggers = $json.triggers | Select-Object -Property * -ExcludeProperty settingsSourceType

#Adding Key: "pollingInterval"
$json.triggers | Add-Member -type NoteProperty -name pollingInterval -value 0

#Convert PSObject back to Json
$json = $json | ConvertTo-Json -Depth 20

#Update Pipeline
$request = "https://dev.azure.com/$($Organization)/$($Project)/_apis/build/definitions/$($PipelineId)?api-version=$($apiVersion)"
$result = Invoke-RestMethod -Uri $request -Method Put -ContentType "application/json" -Headers @{Authorization = ("Basic {0}" -f $authorization) } -Body $json

Answer 1

我看了你的剧本。删除 SettingSourceType 和 PollingInterval 部分可以解决问题：

$request = "https://dev.azure.com/$($Organization)/$($Project)/_apis/build/definitions/$($PipelineId)?api-version=$($apiVersion)"
$json = Invoke-WebRequest -Uri $request -Method Get -Headers @{Authorization = "Basic $authorization" } -ContentType "application/json" | ConvertFrom-Json

#set Branch Filter
$defaultBranch = "feature/myfeature"
$branchFilters += @("+refs/heads/$($defaultBranch)")
$json.triggers[0].branchFilters = $branchFilters

#Convert PSObject back to Json
$json = $json | ConvertTo-Json -Depth 20

让我知道该解决方案是否也适合您。

请注意，有一种更简单的方法来设置分支过滤器。事实上，您可以直接从 YAML 执行此操作，无需覆盖 YAML 配置。
看一下 此处的 Azure DevOps 文档段落！