JenkinsQueueJob@2 — задача задания очереди Jenkins версии 2

Используйте эту задачу для постановки задания в очередь на сервере Jenkins.

Синтаксис

# Jenkins queue job v2
# Queue a job on a Jenkins server.
- task: JenkinsQueueJob@2
  inputs:
    serverEndpoint: # string. Required. Jenkins service connection. 
    jobName: # string. Required. Job name. 
    #isMultibranchJob: false # boolean. Job is of multibranch pipeline type. Default: false.
    #multibranchPipelineBranch: # string. Required when isMultibranchJob = true. Multibranch pipeline branch. 
    #captureConsole: true # boolean. Capture console output and wait for completion. Default: true.
    #capturePipeline: true # boolean. Optional. Use when captureConsole = true. Capture pipeline output and wait for pipeline completion. Default: true.
  # Advanced
    #isParameterizedJob: false # boolean. Alias: parameterizedJob. Parameterized job. Default: false.
    #jobParameters: # string. Optional. Use when parameterizedJob = true. Job parameters. 
    #failOnUnstableResult: false # boolean. Fail on unstable result. Default: false.
    #retryCount: '3' # string. Number of retries for failed connection. Default: 3.
    #delayBetweenRetries: '60' # string. Time between retries. Default: 60.
# Jenkins queue job v2
# Queue a job on a Jenkins server.
- task: JenkinsQueueJob@2
  inputs:
    serverEndpoint: # string. Required. Jenkins service connection. 
    jobName: # string. Required. Job name. 
    #isMultibranchJob: false # boolean. Job is of multibranch pipeline type. Default: false.
    #multibranchPipelineBranch: # string. Required when isMultibranchJob = true. Multibranch pipeline branch. 
    #captureConsole: true # boolean. Capture console output and wait for completion. Default: true.
    #capturePipeline: true # boolean. Optional. Use when captureConsole = true. Capture pipeline output and wait for pipeline completion. Default: true.
  # Advanced
    #isParameterizedJob: false # boolean. Alias: parameterizedJob. Parameterized job. Default: false.
    #jobParameters: # string. Optional. Use when parameterizedJob = true. Job parameters.
# Jenkins Queue Job v2
# Queue a job on a Jenkins server.
- task: JenkinsQueueJob@2
  inputs:
    serverEndpoint: # string. Required. Jenkins service connection. 
    jobName: # string. Required. Job name. 
    #isMultibranchJob: false # boolean. Job is of multibranch pipeline type. Default: false.
    #multibranchPipelineBranch: # string. Required when isMultibranchJob = true. Multibranch pipeline branch. 
    #captureConsole: true # boolean. Capture console output and wait for completion. Default: true.
    #capturePipeline: true # boolean. Optional. Use when captureConsole = true. Capture pipeline output and wait for pipeline completion. Default: true.
  # Advanced
    #isParameterizedJob: false # boolean. Alias: parameterizedJob. Parameterized job. Default: false.
    #jobParameters: # string. Optional. Use when parameterizedJob = true. Job parameters.

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

serverEndpoint - Подключение службы Jenkins
string. Обязательный.

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


jobName - Имя задания
string. Обязательный.

Имя задания Jenkins для постановки в очередь. Это должно точно соответствовать имени задания на сервере Jenkins.


isMultibranchJob - Задание имеет тип многоуровневого конвейера
boolean. Значение по умолчанию: false.

Это задание является многоуровневый конвейер. Если он указан, добавьте соответствующее имя ветви. Для этих входных данных требуется подключаемый модуль Team Foundation Server для Jenkins версии 5.3.4 или более поздней версии.


multibranchPipelineBranch - Ветвь многоуровневого конвейера
string. Требуется при .isMultibranchJob = true

Помещает в очередь это многоуровневое задание конвейера в указанной ветви. Для этих входных данных требуется подключаемый модуль Team Foundation Server для Jenkins версии 5.3.4 или более поздней версии.


captureConsole - Запись выходных данных консоли и ожидание завершения
boolean. Значение по умолчанию: true.

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


capturePipeline - Запись выходных данных конвейера и ожидание завершения конвейера
boolean. Необязательный элемент. Используйте при captureConsole = true. Значение по умолчанию: true.

Если этот параметр указан, эта задача записывает полные выходные данные консоли конвейера сборки Jenkins, ожидает завершения полного конвейера сборки Jenkins и завершается успешно или сбоем на основе результата конвейера сборки Jenkins. В противном случае после завершения первого задания Jenkins эта задача успешно завершается без ожидания выполнения полного конвейера сборки Jenkins.


isParameterizedJob - Параметризованное задание
Входной псевдоним: parameterizedJob. boolean. Значение по умолчанию: false.

Указывает, принимает ли задание Jenkins параметры. Используйте эти входные данные, даже если используются все значения параметров по умолчанию, а параметры фактически не указаны.


jobParameters - Параметры задания
string. Необязательный элемент. Используйте при parameterizedJob = true.

Задает параметры задания с по одному на строку в формате <parameterName>=<parameterValue>.

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

Поддерживаются переменные. Чтобы задать commitId значение параметра для ИД фиксации Git сборки, например, можно использовать: commitId=$(Build.SourceVersion). Дополнительные сведения см. в документации по переменным.

Поддерживаемые типы параметров Jenkins:

  • Boolean
  • Choice
  • Password
  • String

failOnUnstableResult - Сбой при нестабильном результате
boolean. Значение по умолчанию: false.

Определяет строгость определения успешности, а также указывает, следует ли рассматривать нестабильное состояние как сбой. Значение false — для нестрогая версия, а — true для строгой версии. Если задано значение true, нестабильный результат сборки обрабатывается как сбой. В противном случае нестабильный результат рассматривается как успех.


retryCount - Количество повторных попыток для неудачного подключения
string. Значение по умолчанию: 3.

Указывает количество повторных попыток подключения при сбое или ошибке подключения.


delayBetweenRetries - Время между повторными попытками
string. Значение по умолчанию: 60.

Указывает время между повторными попытками подключения при возникновении ошибки. Значение указывается в секундах.


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

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

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

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

JENKINS_JOB_ID
Идентификатор экземпляра задания Jenkins, помещенного в очередь этой задачей. Используйте эту переменную в задаче Jenkins Download Artifacts, чтобы скачать артефакты для конкретного экземпляра задания.

Комментарии

Используйте эту задачу для постановки задания в очередь на сервере Jenkins.

Подключаемый модуль Team Foundation Server

Подключаемый модуль Team Foundation Server (версии 5.2.0 или более поздней) можно использовать для автоматического сбора файлов из рабочей области Jenkins и их загрузки в сборку.

Чтобы настроить его, выполните приведенные далее действия.

  1. Установите подключаемый модуль Team Foundation Server на сервере Jenkins.

  2. На сервере Jenkins для каждого задания, из которых вы хотите собирать результаты, добавьте действие Сбор результатов для Azure Pipelines/TFS после сборки, а затем настройте его с одной или несколькими парами типа результатов и шаблоном включения файла.

  3. В задании очереди Jenkins задача сборки включает выходные данные консоли Capture и ожидает завершения для сбора результатов из задания корневого уровня или выходных данных конвейера Сбор и ожидает завершения конвейера, чтобы получить результаты из всех заданий конвейера.

Результаты будут загружены в $(Build.StagingDirectory)/jenkinsResults/Job Name/team-results.zip и извлечены в это расположение. Каждый набор типов результатов, собранных подключаемым модулем, будет находиться в каталоге team-results $(Build.StagingDirectory)/jenkinsResults/Job Name/team-results/ResultType/. Это каталог, в котором результаты сборки могут публиковаться подчиненными задачами (например, публикация результатов тестирования и публикация результатов покрытия кода).

Требования

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