Использование переменных в классических конвейерах выпуска

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

Использование переменных в классических потоках выпуска — это удобный способ обмена и транспортировки данных на протяжении всего процесса. Каждая переменная хранится в виде строки, и ее значение может изменяться между выполнением конвейера.

При настройке задач для развертывания приложения на каждом этапе классического конвейера выпуска переменные помогут вам:

• Упрощение настройки. Определите универсальный конвейер развертывания один раз и легко адаптируйте его для различных этапов. Например, используйте переменную для представления строки подключения веб-развертывания, изменяя ее значение по мере необходимости для каждого этапа. Эти переменные называются пользовательскими переменными.

• Используйте контекстную информацию: получите доступ к сведениям о контексте выпуска, таким как этап, артефакт или агент, выполняющий развертывание. Например, для сценариев может потребоваться расположение сборки для скачивания или рабочий каталог агента для создания временных файлов. Эти переменные называются переменными по умолчанию.

Переменные по умолчанию

Переменные по умолчанию предоставляют важные сведения о контексте выполнения для выполняемых задач и скриптов. Эти переменные предоставляют доступ к сведениям о системе, выпуске, стадии или агенте , в котором они работают.

За исключением System.Debug, переменные по умолчанию доступны только для чтения, а система автоматически задает их значения.

Некоторые из наиболее важных переменных описаны в следующих таблицах. Чтобы просмотреть полный список, просмотрите текущие значения всех переменных.

Системные переменные

Переменные выпуска

Переменные этапа выпуска

Переменные агента

Выпуск переменных артефактов

Для каждого артефакта, на который вы ссылаетесь в выпуске, используйте следующие переменные артефакта. Обратите внимание, что не все переменные применяются к каждому типу артефакта. В следующей таблице перечислены переменные артефакта по умолчанию и приведены примеры их значений на основе типа артефакта. Если пример пуст, он указывает, что переменная не применима для этого типа артефакта.

Замените заполнитель {alias} на значение, которое вы укажете для псевдонима источника артефакта или на значение по умолчанию, созданное для конвейера выпуска.

Основные переменные артефакта

В классических конвейерах выпуска при использовании нескольких артефактов можно назначить один артефакт в качестве основного артефакта. Затем Azure Pipelines заполняет следующие переменные для указанного первичного артефакта.

Использование переменных по умолчанию

Переменные по умолчанию можно использовать двумя способами: в качестве параметров для задач в конвейере выпуска или в сценариях.

Используйте переменную по умолчанию непосредственно в качестве входных данных для задачи. Например, чтобы передать Release.Artifacts.{Artifact alias}.DefinitionName в качестве аргумента задаче PowerShell для артефакта с ASPNET4.CI в качестве псевдонима, используйте $(Release.Artifacts.ASPNET4.CI.DefinitionName).

Чтобы использовать переменную по умолчанию в скрипте, замените . в именах переменных по умолчанию на _. Например, чтобы распечатать значение артефакта Release.Artifacts.{Artifact alias}.DefinitionName с ASPNET4.CI в качестве псевдонима в скрипте PowerShell, используйте $env:RELEASE_ARTIFACTS_ASPNET4_CI_DEFINITIONNAME. Исходный псевдоним , ASPNET4.CI, заменяется ASPNET4_CI.

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

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

• Группы переменных: используйте группы переменных для совместного использования значений во всех определениях проекта. Этот подход полезен, если вы хотите использовать одинаковые значения для определений, этапов и задач в проекте и управления ими из одного расположения. Определение групп переменных и управление ими в библиотеке конвейеров>.

• Переменные конвейера выпуска: используйте переменные конвейера выпуска для совместного использования значений на всех этапах конвейера выпуска. Этот подход идеально подходит для сценариев, в которых требуется единообразное значение на всех этапах и задачах, с возможностью его обновления из одного места. Определите эти переменные и управляйте ими на вкладке "Переменные " конвейера выпуска. На странице «Переменные конвейера» в выпадающем списке Область выберите Релиз, чтобы добавить переменную.

• Переменные этапа: используйте переменные этапа для совместного использования значений в определенном этапе конвейера выпуска. Этот подход полезен для значений, которые отличаются от этапа до этапа, но согласованы во всех задачах на этапе. Определите эти переменные и управляйте ими на вкладке "Переменные " конвейера выпуска. На странице "Переменные конвейера" в раскрывающемся списке "Область" задайте соответствующую среду при добавлении переменной.

С помощью пользовательских переменных на уровне проекта, конвейера выпуска и этапа можно:

• Избегайте дублирования значений, чтобы было проще обновлять все вхождения одним изменением.

• Защита конфиденциальных значений путем предотвращения их просмотра или изменения пользователями. Чтобы пометить переменную как безопасную (секретную), щелкните значок рядом с переменной.

  Внимание

  Значения скрытых переменных (секрет) безопасно хранятся на сервере, и пользователи не могут просматривать их после сохранения. Во время развертывания Azure Pipelines расшифровывает эти значения, когда задачи ссылаются на них, и передает их агенту через безопасный канал HTTPS.

Использование пользовательских переменных

Чтобы использовать пользовательские переменные в задачах, заключите имя переменной в скобки и предшествуйте ему символом $ . Например, если у вас есть переменная с именем adminUserName, вставьте его текущее значение в задачу как $(adminUserName).

Определение и изменение переменных в скрипте

Чтобы определить или изменить переменную из скрипта, используйте task.setvariable команду ведения журнала. Обновленное значение переменной распространяется на выполняемое задание и не сохраняется на разных этапах заданий или этапов. Обратите внимание, что имена переменных преобразуются в верхний регистр, где "." и " " заменяются на "_".

Например, Agent.WorkFolder преобразуется в AGENT_WORKFOLDER.

• В Windows получите доступ к этой переменной как %AGENT_WORKFOLDER% или $env:AGENT_WORKFOLDER.
• В Linux и macOS используйте $AGENT_WORKFOLDER.

@echo ##vso[task.setvariable variable=sauce]crushed tomatoes
@echo ##vso[task.setvariable variable=secret.Sauce;issecret=true]crushed tomatoes with garlic

"$(sauce)" "$(secret.Sauce)"

@echo off
set sauceArgument=%~1
set secretSauceArgument=%~2
@echo No problem reading %sauceArgument% or %SAUCE%
@echo But I cannot read %SECRET_SAUCE%
@echo But I can read %secretSauceArgument% (but the log is redacted so I do not spoil the secret)

Write-Host "##vso[task.setvariable variable=sauce]crushed tomatoes"
Write-Host "##vso[task.setvariable variable=secret.Sauce;issecret=true]crushed tomatoes with
            garlic"

-sauceArgument "$(sauce)" -secretSauceArgument "$(secret.Sauce)"

Param(
   [string]$sauceArgument,
   [string]$secretSauceArgument
)
Write-Host No problem reading $env:SAUCE or $sauceArgument
Write-Host But I cannot read $env:SECRET_SAUCE
Write-Host But I can read $secretSauceArgument "(but the log is redacted so I do not spoil the secret)"

- pwsh: |
      Write-Host No problem reading $(sauce)
      Write-Host But I cannot read $env:SECRET_SAUCE
      Write-Host But I can read $(secret.Sauce) "(but the log is redacted so I do not spoil the secret)"

#!/bin/bash
echo "##vso[task.setvariable variable=sauce]crushed tomatoes"
echo "##vso[task.setvariable variable=secret.Sauce;issecret=true]crushed tomatoes with garlic"

"$(sauce)" "$(secret.Sauce)"

#!/bin/bash
echo "No problem reading $SAUCE"
echo "But I cannot read $SECRET_SAUCE"

Выходные данные консоли из чтения переменных:

No problem reading crushed tomatoes or crushed tomatoes
But I cannot read 
But I can read ******** (but the log is redacted so I do not spoil the secret)

Просмотр текущих значений всех переменных

1. Выберите Конвейеры>Выпуски, а затем выберите конвейер выпуска.

2. Откройте сводный отчет о выпуске и выберите интересующий вас этап. В списке шагов выберите "Инициализация задания".

   

3. На этом шаге открываются журналы. Прокрутите вниз, чтобы просмотреть значения, которые агент использует для этого задания.

   

Запуск релиза в режиме отладки

Запуск выпуска в режиме отладки позволяет диагностировать и устранять проблемы, отображая дополнительные сведения во время выполнения выпуска. Вы можете включить режим отладки для всего выпуска или только для задач на определенном этапе выпуска.

• Чтобы включить режим отладки для всего выпуска, добавьте переменную с именем System.Debug со значением true на вкладку "Переменные " конвейера выпуска.

• Чтобы включить режим отладки для определенного этапа, откройте диалоговое окно "Настройка этапа" из контекстного меню этапа и добавьте переменную с именем System.Debug со значением true на вкладку "Переменные".

• Кроме того, создайте группу переменных, содержащую переменную с именем System.Debug значения true, и свяжите эту группу переменных с конвейером выпуска.

Связанный контент

• Источники артефактов в классических конвейерах выпуска

• Развертывание артефактов пулл-реквеста

• Использование переменных в группе переменных