Ações de fila do Jenkins

Esta página fornece uma referência para as ações de fila do Jenkins disponíveis no catálogo de ações de automação de fluxo de trabalho. Use essas ações para inspecionar e gerenciar as compilações que aguardam na fila de compilação do Jenkins.

Pré-requisitos

Antes de usar as ações de fila do Jenkins na automação de fluxo de trabalho, é necessário:

Um servidor Jenkins acessível a partir do New Relic Workflow Automation via HTTPS. Se a sua instância do Jenkins estiver atrás de um firewall ou em uma rede privada, permita o acesso de entrada do New Relic Workflow Automation.
Um token de API do Jenkins para a conta na qual o fluxo de trabalho é executado. Gere um a partir do seu perfil de usuário do Jenkins: Configure > API Token > Add new Token.
Um segredo no New Relic Secrets Service contendo o valor codificado em Base64 de username:apiToken. Referencie-o no fluxo de trabalho como ${{ :secrets:<keyName> }}.

Obter um item da fila do Jenkins

O identificador da ação é jenkins.queue.getItem.

Obtém detalhes do item da fila, incluindo o número do build assim que a execução é iniciada. Use esta ação para consultar a fila após acionar um build com jenkins.job.trigger para recuperar o número do build necessário para outras ações de job.

O campo executable.number na resposta contém o número do build assim que o build começa a ser executado. É null enquanto o item ainda está na fila.

A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.

Entrada	Tipo	Descrição	Exemplo
authToken	String (segredo)	Obrigatório. `username:apiToken` codificado em Base64 para autenticação básica HTTP.	`${{ :secrets:jenkinsAuthToken }}`
url	Corda	Obrigatório. URL do servidor Jenkins.	`https://jenkins.example.com`
queueId	Interno	Obrigatório. ID do item da fila retornado de `jenkins.job.trigger` . Use isso para rastrear a compilação e recuperar o número da compilação assim que a execução for iniciada.	`123`
selectors	Lista	Opcional. Seletores JQ para extrair campos específicos da resposta HTTP.	`[{"name": "buildNumber", "expression": ".responseBody \| fromjson.executable.number // null"}]`

A tabela a seguir descreve todos os campos de saída retornados por esta ação.

Saída	Tipo	Descrição
response	Objeto	Detalhes do item da fila. `executable.number` contém o número do build assim que o build começa a ser executado — é `null` enquanto o item ainda está na fila. `{ "id": 123, "blocked": false, "buildable": false, "cancelled": false, "why": null, "executable": { "number": 42, "url": "http://jenkins.example.com/job/my-job/42/" }, "task": { "name": "my-job", "url": "http://jenkins.example.com/job/my-job/" }, "inQueueSince": 1625234567000 }`
success	Boleano	`true` em caso de sucesso, `false` em caso de falha.
errorMessage	Corda	Mensagem de erro se a solicitação falhar. `null` em caso de sucesso.

Saída

Tipo

Descrição

response

Objeto

Detalhes do item da fila. executable.number contém o número do build assim que o build começa a ser executado — é null enquanto o item ainda está na fila.

{
  "id": 123,
  "blocked": false,
  "buildable": false,
  "cancelled": false,
  "why": null,
  "executable": {
    "number": 42,
    "url": "http://jenkins.example.com/job/my-job/42/"
  },
  "task": {
    "name": "my-job",
    "url": "http://jenkins.example.com/job/my-job/"
  },
  "inQueueSince": 1625234567000
}

success

Boleano

true

em caso de sucesso,

false

em caso de falha.

errorMessage

Corda

Mensagem de erro se a solicitação falhar.

null

em caso de sucesso.

O exemplo a seguir aciona um build e consulta a fila até que o número do build esteja disponível.

Exemplo de fluxo de trabalho
name: poll-jenkins-queue description: 'Trigger a build and poll the queue until the build number is available' steps: - name: trigger_build type: action action: jenkins.job.trigger version: 1 inputs: authToken: ${{ :secrets:jenkinsAuthToken }} url: "https://jenkins.example.com" jobName: "my-application-build" selectors: - name: "queueId" expression: ".queueId" next: poll_queue - name: poll_queue type: loop for: in: ${{ [range(0; 10)] }} steps: - name: get_queue_item type: action action: jenkins.queue.getItem version: 1 inputs: authToken: ${{ :secrets:jenkinsAuthToken }} url: "https://jenkins.example.com" queueId: ${{ .steps.trigger_build.outputs.queueId }} selectors: - name: "buildNumber" expression: ".responseBody \| fromjson.executable.number // null" - name: check_if_started type: switch switch: - condition: ${{ .steps.get_queue_item.outputs.buildNumber != null }} next: end next: wait_and_retry - name: wait_and_retry type: wait seconds: 2 next: continue

Exemplo de fluxo de trabalho

name: poll-jenkins-queue
description: 'Trigger a build and poll the queue until the build number is available'
steps:
  - name: trigger_build
    type: action
    action: jenkins.job.trigger
    version: 1
    inputs:
      authToken: ${{ :secrets:jenkinsAuthToken }}
      url: "https://jenkins.example.com"
      jobName: "my-application-build"
      selectors:
        - name: "queueId"
          expression: ".queueId"
    next: poll_queue

  - name: poll_queue
    type: loop
    for:
      in: ${{ [range(0; 10)] }}
      steps:
        - name: get_queue_item
          type: action
          action: jenkins.queue.getItem
          version: 1
          inputs:
            authToken: ${{ :secrets:jenkinsAuthToken }}
            url: "https://jenkins.example.com"
            queueId: ${{ .steps.trigger_build.outputs.queueId }}
            selectors:
              - name: "buildNumber"
                expression: ".responseBody | fromjson.executable.number // null"

        - name: check_if_started
          type: switch
          switch:
            - condition: ${{ .steps.get_queue_item.outputs.buildNumber != null }}
              next: end
          next: wait_and_retry

        - name: wait_and_retry
          type: wait
          seconds: 2
          next: continue

Cancelar um build do Jenkins na fila

O identificador da ação é jenkins.queue.cancel.

Cancela um build do Jenkins na fila antes de iniciar a execução. Requer um queueId obtido de uma chamada jenkins.job.trigger anterior.

Esta ação falha se o build já tiver começado a ser executado. Para interromper um build já em execução, use jenkins.job.stop em vez disso.

A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.

Entrada	Tipo	Descrição	Exemplo
authToken	String (segredo)	Obrigatório. `username:apiToken` codificado em Base64 para autenticação básica HTTP.	`${{ :secrets:jenkinsAuthToken }}`
url	Corda	Obrigatório. URL do servidor Jenkins.	`https://jenkins.example.com`
queueId	Interno	Obrigatório. ID do item da fila a ser cancelado. O item ainda deve estar na fila e não estar em execução.	`123`
selectors	Lista	Opcional. Seletores JQ para extrair campos específicos da resposta HTTP.	`[{"name": "statusCode", "expression": ".statusCode"}]`

A tabela a seguir descreve todos os campos de saída retornados por esta ação.

Saída	Tipo	Descrição
response	Objeto	O Jenkins retorna HTTP 204 (No Content) em caso de cancelamento bem-sucedido. O Jenkins retorna 404 se o item da fila não for encontrado ou já tiver começado a ser executado. Exemplo: `{ "statusCode": 204, "body": "" }`
success	Boleano	`true` em caso de sucesso, `false` em caso de falha.
errorMessage	Corda	Mensagem de erro se o cancelamento falhar. `null` em caso de sucesso.

Saída

Tipo

Descrição

response

Objeto

O Jenkins retorna HTTP 204 (No Content) em caso de cancelamento bem-sucedido. O Jenkins retorna 404 se o item da fila não for encontrado ou já tiver começado a ser executado. Exemplo:

{ "statusCode": 204, "body": "" }

success

Boleano

true

em caso de sucesso,

false

em caso de falha.

errorMessage

Corda

Mensagem de erro se o cancelamento falhar.

null

em caso de sucesso.

O exemplo a seguir aciona uma compilação do Jenkins e a cancela antes que ela comece a ser executada.

Exemplo de fluxo de trabalho
name: cancel-queued-jenkins-build description: 'Trigger a Jenkins build then cancel it before it starts executing' steps: - name: trigger_build type: action action: jenkins.job.trigger version: 1 inputs: authToken: ${{ :secrets:jenkinsAuthToken }} url: "https://jenkins.example.com" jobName: "my-application-build" selectors: - name: "queueId" expression: ".queueId" next: cancel_build - name: cancel_build type: action action: jenkins.queue.cancel version: 1 inputs: authToken: ${{ :secrets:jenkinsAuthToken }} url: "https://jenkins.example.com" queueId: ${{ .steps.trigger_build.outputs.queueId }} next: end

Exemplo de fluxo de trabalho

name: cancel-queued-jenkins-build
description: 'Trigger a Jenkins build then cancel it before it starts executing'
steps:
  - name: trigger_build
    type: action
    action: jenkins.job.trigger
    version: 1
    inputs:
      authToken: ${{ :secrets:jenkinsAuthToken }}
      url: "https://jenkins.example.com"
      jobName: "my-application-build"
      selectors:
        - name: "queueId"
          expression: ".queueId"
    next: cancel_build

  - name: cancel_build
    type: action
    action: jenkins.queue.cancel
    version: 1
    inputs:
      authToken: ${{ :secrets:jenkinsAuthToken }}
      url: "https://jenkins.example.com"
      queueId: ${{ .steps.trigger_build.outputs.queueId }}
    next: end

Listar todos os itens na fila de build do Jenkins

O identificador da ação é jenkins.queue.list.

Lista todos os itens atualmente na fila de build do Jenkins.

A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.

Entrada

Tipo

Descrição

Exemplo

authToken

String (segredo)

Obrigatório.

username:apiToken

codificado em Base64 para autenticação básica HTTP.

${{ :secrets:jenkinsAuthToken }}

url

Corda

Obrigatório.

URL do servidor Jenkins.

https://jenkins.example.com

selectors

Lista

Opcional.

Seletores JQ para extrair campos específicos da resposta HTTP.

[{"name": "queueCount", "expression": ".responseBody | fromjson.items | length"}]

A tabela a seguir descreve todos os campos de saída retornados por esta ação.

Saída	Tipo	Descrição
response	Objeto	Todos os itens da fila. Cada item inclui `id`, `task` (informações do trabalho) e `executable` (informações da compilação assim que a compilação é iniciada). `{ "items": [ { "id": 123, "blocked": false, "buildable": true, "cancelled": false, "why": "Waiting for next available executor", "task": { "name": "job1", "url": "http://jenkins.example.com/job/job1/" }, "inQueueSince": 1625234567000 } ] }`
success	Boleano	`true` em caso de sucesso, `false` em caso de falha.
errorMessage	Corda	Mensagem de erro se a solicitação falhar. `null` em caso de sucesso.

Saída

Tipo

Descrição

response

Objeto

Todos os itens da fila. Cada item inclui id, task (informações do trabalho) e executable (informações da compilação assim que a compilação é iniciada).

{
  "items": [
    {
      "id": 123,
      "blocked": false,
      "buildable": true,
      "cancelled": false,
      "why": "Waiting for next available executor",
      "task": {
        "name": "job1",
        "url": "http://jenkins.example.com/job/job1/"
      },
      "inQueueSince": 1625234567000
    }
  ]
}

success

Boleano

true

em caso de sucesso,

false

em caso de falha.

errorMessage

Corda

Mensagem de erro se a solicitação falhar.

null

em caso de sucesso.

O exemplo a seguir lista todos os itens na fila de build do Jenkins e extrai a contagem.

Exemplo de fluxo de trabalho
`name: list-jenkins-queue description: 'List all items currently in the Jenkins build queue' steps: - name: list_queue type: action action: jenkins.queue.list version: 1 inputs: authToken: ${{ :secrets:jenkinsAuthToken }} url: "https://jenkins.example.com" selectors: - name: "queueItems" expression: ".responseBody \| fromjson.items" - name: "queueCount" expression: ".responseBody \| fromjson.items \| length" next: end`

Exemplo de fluxo de trabalho

name: list-jenkins-queue
description: 'List all items currently in the Jenkins build queue'
steps:
  - name: list_queue
    type: action
    action: jenkins.queue.list
    version: 1
    inputs:
      authToken: ${{ :secrets:jenkinsAuthToken }}
      url: "https://jenkins.example.com"
      selectors:
        - name: "queueItems"
          expression: ".responseBody | fromjson.items"
        - name: "queueCount"
          expression: ".responseBody | fromjson.items | length"
    next: end

Esta tradução de máquina é fornecida para sua comodidade.

Pré-requisitos.css-21sua1{background:none;border:none;width:0;padding:0;}

Obter um item da fila do Jenkins

Cancelar um build do Jenkins na fila

Listar todos os itens na fila de build do Jenkins

Pré-requisitos