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

Статья
07/02/2024

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

Синтаксис

# Jenkins Queue Job v1
# Queue a job on a Jenkins server.
- task: JenkinsQueueJob@1
  inputs:
    serverEndpoint: # string. Required. Jenkins service endpoint. 
    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
    #parameterizedJob: false # boolean. 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.

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

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

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

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

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

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

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

Boolean
Choice
Password
String

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

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

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

Нет.

Требования

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

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