Bash@3 — задача Bash версии 3

Статья
07/02/2024

Используйте эту задачу для запуска скрипта Bash в macOS, Linux или Windows.

Синтаксис

# Bash v3
# Run a Bash script on macOS, Linux, or Windows.
- task: Bash@3
  inputs:
    #targetType: 'filePath' # 'filePath' | 'inline'. Type. Default: filePath.
    filePath: # string. Required when targetType = filePath. Script Path. 
    #arguments: # string. Optional. Use when targetType = filePath. Arguments. 
    #script: # string. Required when targetType = inline. Script. 
  # Advanced
    #workingDirectory: # string. Working Directory. 
    #failOnStderr: false # boolean. Fail on Standard Error. Default: false.
    #bashEnvValue: # string. Set value for BASH_ENV environment variable.

# Bash v3
# Run a Bash script on macOS, Linux, or Windows.
- task: Bash@3
  inputs:
    #targetType: 'filePath' # 'filePath' | 'inline'. Type. Default: filePath.
    filePath: # string. Required when targetType = filePath. Script Path. 
    #arguments: # string. Optional. Use when targetType = filePath. Arguments. 
    #script: # string. Required when targetType = inline. Script. 
  # Advanced
    #workingDirectory: # string. Working Directory. 
    #failOnStderr: false # boolean. Fail on Standard Error. Default: false.
    #noProfile: true # boolean. Don't load the profile startup/initialization files. Default: true.
    #noRc: true # boolean. Don't read the `~/.bashrc' initialization file. Default: true.

# Bash v3
# Run a Bash script on macOS, Linux, or Windows.
- task: Bash@3
  inputs:
    #targetType: 'filePath' # 'filePath' | 'inline'. Type. Default: filePath.
    filePath: # string. Required when targetType = filePath. Script Path. 
    #arguments: # string. Optional. Use when targetType = filePath. Arguments. 
    #script: # string. Required when targetType = inline. Script. 
  # Advanced
    #workingDirectory: # string. Working Directory. 
    #failOnStderr: false # boolean. Fail on Standard Error. Default: false.

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

targetType - Тип
string. Допустимые значения: filePath (Путь к файлу), inline. Значение по умолчанию: filePath.

Тип скрипта целевых объектов: путь к файлу или встроенный.

filePath - Путь к скрипту
string. Требуется, если targetType = filePath.

Путь к выполняемму скрипту. Это должен быть полный путь или относительно $(System.DefaultWorkingDirectory).

arguments - Аргументы
string. Необязательный элемент. Используйте при targetType = filePath.

Аргументы, передаваемые в скрипт оболочки. Порядковые параметры или именованные параметры.

script - Сценарий
string. Требуется, если targetType = inline. Значение по умолчанию: # Write your commands here\n\necho 'Hello world'.

Содержимое скрипта.

script - Сценарий
string. Требуется, если targetType = inline. Значение по умолчанию: # Write your commands here\n\n# Use the environment variables input below to pass secret variables to this script.

Содержимое скрипта.

workingDirectory - Рабочий каталог
string.

Указывает рабочий каталог, в котором требуется выполнить команду. Если оставить его пустым, рабочим каталогом будет $(Build.SourcesDirectory).

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

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

bashEnvValue - Установка значения для переменной среды BASH_ENV
string.

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

noProfile - Не загружайте файлы запуска и инициализации профиля
boolean. Значение по умолчанию: true.

Не загружайте файл /etc/profile запуска для всей системы или файлы личной инициализации.

noRc - **Не читайте ~/.bashrc' initialization file**<br> логическое. Default value: значение true.

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

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

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

Нет.

Remarks

Задача bash имеет ярлык в YAML: steps.bash.

steps:
- bash: string # Required as first property. An inline script. 
  ## Other task inputs

Задача Bash найдет первую реализацию Bash в вашей системе. При запуске which bash в Linux, macOS или where bash Windows вы получите представление о том, какой из них будет выбран.

Сведения о файлах запуска Bash

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

Существует несколько вариантов определения переменной BASH_ENV среды в конвейере. Во-первых, можно задать BASH_ENV переменную среды в качестве переменной конвейера. В этом случае каждый экземпляр задачи Bash будет пытаться развернуть значение переменной BASH_ENV и использовать его значение.

variables:
  BASH_ENV: "~/.profile"

steps:
- task: Bash@3
  inputs:
    targetType: 'inline'
    script: env

Другой вариант — задать BASH_ENV для одного конкретного экземпляра задачи Bash. Это можно сделать двумя способами:

Первый способ — использовать bashEnvValue входные данные задачи, см. пример для справки:

steps:
- task: Bash@3
  inputs:
    targetType: 'inline'
    script: env
    bashEnvValue: '~/.profile'

Другой способ — задать BASH_ENV переменную в качестве переменной среды для задачи конвейера env с помощью ключевое слово, например:

- task: Bash@3
  inputs:
    targetType: 'inline'
    script: env
  env:
    BASH_ENV: '~/.profile'

Примечание

Обратите внимание, что если bashEnvValue входные данные определены в задаче Bash, задача конвейера переопределит значение переменной BASH_ENV значением из bashEnvValue входных данных в случае, когда BASH_ENV переменная среды уже определена в среде.

Скрипты Bash, возвращенные в репозиторий, должны иметь исполняемый файл (chmod +x). В противном случае задача отобразит предупреждение и source файл.

Примеры

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

steps:
- task: Bash@3
  inputs:
    targetType: 'inline'
    script: echo $MYSECRET
  env:
    MYSECRET: $(Foo)

В macOS или Linux приведенный выше пример эквивалентен:

steps:
- script: echo $MYSECRET
  env:
    MYSECRET: $(Foo)

Требования

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

Поделиться через