Partilhar via


JenkinsQueueJob@2 - Tarefa de fila do Jenkins v2

Utilize esta tarefa para colocar uma tarefa em fila num servidor Jenkins.

Syntax

# 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.

Entradas

serverEndpoint - Ligação do serviço Jenkins
string. Obrigatório.

Especifica a ligação de serviço para a instância do Jenkins. Clique na ligação Gerir para criar uma nova ligação do serviço Jenkins.


jobName - Nome da tarefa
string. Obrigatório.

O nome da tarefa do Jenkins a colocar em fila. Isto tem de corresponder exatamente ao nome da tarefa no servidor Jenkins.


isMultibranchJob - A tarefa é do tipo de pipeline multibranch
boolean. Valor predefinido: false.

Esta tarefa é um pipeline multibranch. Se for especificado, adicione o nome do ramo adequado. Esta entrada requer o Plug-in do Team Foundation Server para Jenkins v5.3.4 ou posterior.


multibranchPipelineBranch - Ramo de pipeline multibranch
string. Necessário quando isMultibranchJob = true.

Coloca em fila esta tarefa de pipeline multibranch no ramo especificado. Esta entrada requer o Plug-in do Team Foundation Server para Jenkins v5.3.4 ou posterior.


captureConsole - Capturar o resultado da consola e aguardar pela conclusão
boolean. Valor predefinido: true.

Se for especificado, esta entrada captura a saída da consola de compilação do Jenkins, aguarda a conclusão da compilação do Jenkins e é bem-sucedida/falha com base no resultado da compilação do Jenkins. Caso contrário, assim que a tarefa do Jenkins estiver em fila, esta tarefa será concluída com êxito sem aguardar a execução da compilação do Jenkins.


capturePipeline - Capturar a saída do pipeline e aguardar a conclusão do pipeline
boolean. Opcional. Utilize quando captureConsole = true. Valor predefinido: true.

Se for especificada, esta tarefa captura a saída completa da consola do pipeline de compilação do Jenkins, aguarda a conclusão do pipeline de compilação completo do Jenkins e é bem-sucedida/falha com base no resultado do pipeline de compilação do Jenkins. Caso contrário, uma vez concluída a primeira tarefa do Jenkins, esta tarefa é concluída com êxito sem aguardar a execução do pipeline de compilação completo do Jenkins.


isParameterizedJob - Tarefa parametrizada
Alias de entrada: parameterizedJob. boolean. Valor predefinido: false.

Especifica se a tarefa do Jenkins aceita parâmetros. Utilize esta entrada mesmo que todos os valores de parâmetro predefinidos sejam utilizados e não sejam especificados parâmetros.


jobParameters - Parâmetros da tarefa
string. Opcional. Utilize quando parameterizedJob = true.

Especifica os parâmetros da tarefa, com um por linha, no formato de <parameterName>=<parameterValue>.

Para definir um parâmetro para um valor vazio, que é útil para substituir um valor predefinido, deixe de fora o valor do parâmetro. Por exemplo, especifique parameterName=.

As variáveis são suportadas. Para definir um commitId valor de parâmetro para o ID de consolidação do Git da compilação, por exemplo, pode utilizar: commitId=$(Build.SourceVersion). Para obter mais informações, veja a documentação sobre variáveis.

Os tipos de parâmetros do Jenkins suportados são:

  • Boolean
  • Choice
  • Password
  • String

failOnUnstableResult - Falha num resultado instável
boolean. Valor predefinido: false.

Especifica a rigor de uma definição de êxito ou se deve considerar instável como uma falha ou não. O false valor destina-se a uma versão não estrita e destina-se a true uma versão estrita. Se definido como true, um resultado de compilação instável é tratado como uma falha. Caso contrário, um resultado instável é tratado como um sucesso.


retryCount - Número de tentativas de ligação falhada
string. Valor predefinido: 3.

Especifica a quantidade de repetições de ligação quando ocorre uma falha de ligação ou um erro.


delayBetweenRetries - Tempo entre repetições
string. Valor predefinido: 60.

Especifica a quantidade de tempo entre repetições de ligação quando ocorre um erro. Este valor é especificado em segundos.


Opções de controlo de tarefas

Todas as tarefas têm opções de controlo para além das entradas de tarefas. Para obter mais informações, veja Opções de controlo e propriedades de tarefas comuns.

Variáveis de saída

Esta tarefa define as seguintes variáveis de saída, que pode consumir em passos, tarefas e fases a jusante.

JENKINS_JOB_ID
O ID da instância de trabalho do Jenkins colocada em fila por esta tarefa. Utilize esta variável na tarefa Transferir Artefactos do Jenkins para transferir os artefactos para esta instância de trabalho específica.

Observações

Utilize esta tarefa para colocar uma tarefa em fila num servidor Jenkins.

Team Foundation Server Plug-in

Pode utilizar o Plug-in do Team Foundation Server (versão 5.2.0 ou mais recente) para recolher automaticamente ficheiros da área de trabalho do Jenkins e transferi-los para a compilação.

Para configurá-la:

  1. Instale o Plug-in do Team Foundation Server no servidor Jenkins.

  2. No servidor Jenkins, para cada tarefa a partir da qual gostaria de recolher resultados, adicione a ação recolher resultados para o Azure Pipelines/TFS pós-compilação e, em seguida, configure-a com um ou mais pares de tipo de resultado e inclua o padrão de ficheiro.

  3. Na Tarefa de Fila do Jenkins, a tarefa de compilação ativa a saída da consola de Captura e aguarde pela conclusão para recolher os resultados da tarefa de nível de raiz ou a saída do pipeline de captura e aguarde pela conclusão do pipeline para recolher resultados de todas as tarefas do pipeline.

Os resultados serão transferidos para $(Build.StagingDirectory)/jenkinsResults/Job Name/team-results.zip e extraídos para esta localização. Cada conjunto de tipos de resultados recolhidos pelo plug-in estará no diretório de resultados da equipa, $(Build.StagingDirectory)/jenkinsResults/Job Name/team-results/ResultType/. Este é o diretório onde os resultados da compilação podem ser publicados por tarefas a jusante (por exemplo, Publicar Resultados do Teste e Publicar Resultados da Cobertura do Código).

Requisitos

Requisito Description
Tipos de pipeline YAML, Compilação clássica, Versão clássica
É executado em Agent, DeploymentGroup
Exigências Nenhuma
Capacidades Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes na tarefa.
Restrições de comandos Qualquer
Variáveis de definição Qualquer
Versão do agente 2.144.0 ou superior
Categoria da tarefa Compilação
Requisito Description
Tipos de pipeline YAML, Compilação clássica, Versão clássica
É executado em Agente, DeploymentGroup
Exigências Nenhuma
Capacidades Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes na tarefa.
Restrições de comandos Qualquer
Variáveis de tabelas definidas Qualquer
Versão do agente Todas as versões de agente suportadas.
Categoria da tarefa Compilação