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

Статья
02/24/2025

Используйте эту задачу для очереди задания на сервере 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.

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

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

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

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

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

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

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

multibranchPipelineBranch - ветвь конвейера Multibranch
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, чтобы скачать артефакты для этого конкретного экземпляра задания.

Замечания

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

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

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

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

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

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

Требования

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

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

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