Использование скрипта PowerShell для настройки конвейера

Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019

Когда вы будете готовы перейти к основам компиляции и тестирования кода, используйте скрипт PowerShell для добавления бизнес-логики вашей команды в конвейер сборки. Вы можете запустить Windows PowerShell в агенте сборки Windows. PowerShell Core выполняется на любой платформе.

Добавление скрипта PowerShell

YAML

Синтаксис для включения PowerShell Core немного отличается от синтаксиса Windows PowerShell.

1. Отправьте скрипт PowerShell в репозиторий.

2. pwsh Добавьте или powershell шаг. pwsh Ключевое слово — это ярлык для задачи PowerShell для PowerShell Core. Ключевое слово powershell — это еще один ярлык для задачи PowerShell.

# for PowerShell Core
steps:
- pwsh: ./my-script.ps1

# for Windows PowerShell
steps:
- powershell: .\my-script.ps1

Классическое

1. Добавьте задачу скрипта PowerShell в конвейер. Та же задача PowerShell работает для PowerShell Core и Windows PowerShell.

   

2. Добавьте файл в путь к скрипту.

   

Пример скрипта PowerShell: сборки версий

Ниже приведен пример скрипта для версий сборок. Для успешного выполнения скрипта необходимо обновить номер сборки, чтобы использовать формат с четырьмя периодами (например: $(BuildDefinitionName)_$(Year:yyyy).$(Month).$(DayOfMonth)$(Rev:.r)). Номер сборки также можно называть номером выполнения.

YAML

Номер сборки можно настроить в конвейере YAML с name помощью свойства.

name: $(BuildDefinitionName)_$(Year:yyyy).$(Month).$(DayOfMonth)$(Rev:.r)

pool:
  vmImage: windows-latest

steps:
- pwsh: echo $(Build.BuildNumber) //output updated build number

Классическое

1. Чтобы настроить номер сборки в классическом конвейере, сначала добавьте задачу сборки в конвейер.

   

2. Затем укажите номер сборки.

   

# If found use it to version the assemblies.
#
# For example, if the 'Build number format' build pipeline parameter 
# $(BuildDefinitionName)_$(Year:yyyy).$(Month).$(DayOfMonth)$(Rev:.r)
# then your build numbers come out like this:
# "Build HelloWorld_2013.07.19.1"
# This script would then apply version 2013.07.19.1 to your assemblies.
	
# Enable -Verbose option
[CmdletBinding()]
	
# Regular expression pattern to find the version in the build number 
# and then apply it to the assemblies
$VersionRegex = "\d+\.\d+\.\d+\.\d+"
	
# If this script is not running on a build server, remind user to 
# set environment variables so that this script can be debugged
if(-not ($Env:BUILD_SOURCESDIRECTORY -and $Env:BUILD_BUILDNUMBER))
{
	Write-Error "You must set the following environment variables"
	Write-Error "to test this script interactively."
	Write-Host '$Env:BUILD_SOURCESDIRECTORY - For example, enter something like:'
	Write-Host '$Env:BUILD_SOURCESDIRECTORY = "C:\code\FabrikamTFVC\HelloWorld"'
	Write-Host '$Env:BUILD_BUILDNUMBER - For example, enter something like:'
	Write-Host '$Env:BUILD_BUILDNUMBER = "Build HelloWorld_0000.00.00.0"'
	exit 1
}
	
# Make sure path to source code directory is available
if (-not $Env:BUILD_SOURCESDIRECTORY)
{
	Write-Error ("BUILD_SOURCESDIRECTORY environment variable is missing.")
	exit 1
}
elseif (-not (Test-Path $Env:BUILD_SOURCESDIRECTORY))
{
	Write-Error "BUILD_SOURCESDIRECTORY does not exist: $Env:BUILD_SOURCESDIRECTORY"
	exit 1
}
Write-Verbose "BUILD_SOURCESDIRECTORY: $Env:BUILD_SOURCESDIRECTORY"
	
# Make sure there is a build number
if (-not $Env:BUILD_BUILDNUMBER)
{
	Write-Error ("BUILD_BUILDNUMBER environment variable is missing.")
	exit 1
}
Write-Verbose "BUILD_BUILDNUMBER: $Env:BUILD_BUILDNUMBER"
	
# Get and validate the version data
$VersionData = [regex]::matches($Env:BUILD_BUILDNUMBER,$VersionRegex)
switch($VersionData.Count)
{
   0		
      { 
         Write-Error "Could not find version number data in BUILD_BUILDNUMBER."
         exit 1
      }
   1 {}
   default 
      { 
         Write-Warning "Found more than instance of version data in BUILD_BUILDNUMBER." 
         Write-Warning "Will assume first instance is version."
      }
}
$NewVersion = $VersionData[0]
Write-Verbose "Version: $NewVersion"
	
# Apply the version to the assembly property files
$files = gci $Env:BUILD_SOURCESDIRECTORY -recurse -include "*Properties*","My Project" | 
	?{ $_.PSIsContainer } | 
	foreach { gci -Path $_.FullName -Recurse -include AssemblyInfo.* }
if($files)
{
	Write-Verbose "Will apply $NewVersion to $($files.count) files."
	
	foreach ($file in $files) {
		$filecontent = Get-Content($file)
		attrib $file -r
		$filecontent -replace $VersionRegex, $NewVersion | Out-File $file
		Write-Verbose "$file.FullName - version applied"
	}
}
else
{
	Write-Warning "Found no files."
}

Пример скрипта PowerShell: доступ к REST API

В этом примере вы будете использовать SYSTEM_ACCESSTOKEN переменную для доступа к REST API Azure Pipelines.

YAML

Вы можете использовать $env:SYSTEM_ACCESSTOKEN скрипт в конвейере YAML для доступа к токену OAuth.

- task: PowerShell@2
  inputs:
    targetType: 'inline'
    script: |
      $url = "$($env:SYSTEM_TEAMFOUNDATIONCOLLECTIONURI)$env:SYSTEM_TEAMPROJECTID/_apis/build/definitions/$($env:SYSTEM_DEFINITIONID)?api-version=5.0"
              Write-Host "URL: $url"
              $pipeline = Invoke-RestMethod -Uri $url -Headers @{
                  Authorization = "Bearer $env:SYSTEM_ACCESSTOKEN"
              }
              Write-Host "Pipeline = $($pipeline | ConvertTo-Json -Depth 100)"
  env:
     SYSTEM_ACCESSTOKEN: $(System.AccessToken)

Классическое

Чтобы включить скрипт для использования маркера OAuth процесса сборки, перейдите на вкладку "Задачи " определения сборки и на этапе сборки выберите "Разрешить скриптам доступ к токену OAuth", который находится в разделе "Дополнительные параметры ".

После этого скрипт может использовать для SYSTEM_ACCESSTOKEN переменной среды для доступа к REST API Azure Pipelines. Например:

$url = "$($env:SYSTEM_TEAMFOUNDATIONCOLLECTIONURI)$env:SYSTEM_TEAMPROJECTID/_apis/build/definitions/$($env:SYSTEM_DEFINITIONID)?api-version=5.0"
Write-Host "URL: $url"
$pipeline = Invoke-RestMethod -Uri $url -Headers @{
    Authorization = "Bearer $env:SYSTEM_ACCESSTOKEN"
}
Write-Host "Pipeline = $($pipeline | ConvertTo-Json -Depth 100)"

Вопросы и ответы

Какие переменные доступны для меня для использования в сценариях?

В скриптах можно использовать предопределенные переменные . Дополнительные сведения о доступных переменных и их использовании см. в разделе "Использование предопределенных переменных".

Разделы справки задать переменную, чтобы ее можно было считывать последующими скриптами и задачами?

Дополнительные сведения об определении переменных сборки в скрипте см. в статье "Определение и изменение переменных сборки" в скрипте.

Дополнительные сведения об определении переменных выпуска в скрипте см. в статье "Определение и изменение переменных выпуска" в скрипте

Какая ветвь скрипта выполняется сборка?

Сборка будет использовать активную ветвь кода. Если запуск конвейера использует main ветвь, скрипт также будет использовать ветвь main .

Какие типы параметров можно использовать?

Можно использовать именованные параметры. Другие виды параметров, например параметры коммутатора, не поддерживаются. Если вы попытаетесь использовать параметры коммутатора, вы увидите ошибки.