BatchScript@1 — задача "Скрипт пакетной службы" версии 1

Статья
04/29/2024

Используйте эту задачу для запуска Windows .bat или .cmd скрипта. .bat При необходимости скрипт или .cmd может безвозвратно изменять переменные среды.

Синтаксис

# Batch script v1
# Run a Windows command or batch script and optionally allow it to change the environment.
- task: BatchScript@1
  inputs:
    filename: # string. Required. Path. 
    #arguments: # string. Arguments. 
    #modifyEnvironment: False # boolean. Modify Environment. Default: False.
  # Advanced
    #workingFolder: # string. Working folder. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.

# Batch Script v1
# Run a windows cmd or bat script and optionally allow it to change the environment.
- task: BatchScript@1
  inputs:
    filename: # string. Required. Path. 
    #arguments: # string. Arguments. 
    #modifyEnvironment: False # boolean. Modify Environment. Default: False.
  # Advanced
    #workingFolder: # string. Working folder. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.

Входные данные

filename - Путь
string. Обязательный.

Путь к выполняемой скрипту .cmd или .bat . Это должен быть полный путь или один относительно рабочего каталога по умолчанию. (Обратите внимание, что рабочий каталог может отличаться от workingFolder, который можно указать для этой задачи.)

arguments - Аргументы
string.

Аргументы, передаваемые в .cmd скрипт или .bat .

modifyEnvironment - Изменение среды
boolean. Значение по умолчанию: False.

Определяет, повлияют ли изменения переменных среды на последующие задачи.

workingFolder - Рабочая папка
string.

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

failOnStandardError - Сбой при стандартной ошибке
boolean. Значение по умолчанию: false.

Если это верно, эта задача завершится сбоем, если в поток записываются StandardError какие-либо ошибки.

Параметры управления задачами

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

Выходные переменные

Нет.

Remarks

Используйте эту задачу для запуска скрипта Windows .bat или CMD. При необходимости разрешите ему безвозвратно изменять переменные среды.

Примечание

Эта задача несовместима с контейнерами Windows. Если вам нужно запустить пакетный скрипт в контейнере Windows, используйте задачу командной строки .

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

Примеры

Создайте test.bat в корне репозитория:

@echo off
echo Hello World from %AGENT_NAME%.
echo My ID is %AGENT_ID%.
echo AGENT_WORKFOLDER contents:
@dir %AGENT_WORKFOLDER%
echo AGENT_BUILDDIRECTORY contents:
@dir %AGENT_BUILDDIRECTORY%
echo BUILD_SOURCESDIRECTORY contents:
@dir %BUILD_SOURCESDIRECTORY%
echo Over and out.

Чтобы запустить этот скрипт, добавьте в конвейер следующую задачу.

- task: BatchScript@1
  inputs:
    filename: 'test.bat'

Требования

Требование	Описание
Типы конвейеров	YAML, классическая сборка, классический выпуск
Выполняется в	Агент, DeploymentGroup
Требования	Локальные агенты должны иметь возможности , соответствующие следующим требованиям для выполнения заданий, использующих эту задачу: Cmd
Capabilities	Эта задача не удовлетворяет требованиям для последующих задач в задании.
Ограничения команд	Любой
Устанавливаемые переменные	Любой
Версия агента	1.83.0 или более поздней версии
Категория задач	Служебная программа