Acciones de la cola de Jenkins

Esta página proporciona una referencia de las acciones de la cola de Jenkins disponibles en el catálogo de acciones de automatización de flujos de trabajo. Utilice estas acciones para inspeccionar y administrar las compilaciones que esperan en la cola de compilación de Jenkins.

Requisitos previos

Antes de usar las acciones de la cola de Jenkins en la automatización de flujos de trabajo, necesita:

Un servidor de Jenkins accesible desde New Relic Workflow Automation a través de HTTPS. Si su instancia de Jenkins está detrás de un firewall o en una red privada, permita el acceso entrante desde New Relic Workflow Automation.
Un token de API de Jenkins para la cuenta con la que se ejecuta el flujo de trabajo. Genere uno desde el perfil de usuario de Jenkins: Configure > API Token > Add new Token.
Un secreto en el New Relic Secrets Service que contiene el valor codificado en Base64 de username:apiToken. Referéncielo en el flujo de trabajo como ${{ :secrets:<keyName> }}.

Obtener un elemento de la cola de Jenkins

El identificador de la acción es jenkins.queue.getItem.

Obtiene los detalles del elemento de la cola, incluido el número de compilación una vez que comienza la ejecución. Utilice esta acción para sondear la cola después de desencadenar una compilación con jenkins.job.trigger para recuperar el número de compilación necesario para otras acciones del trabajo.

El campo executable.number en la respuesta contiene el número de compilación una vez que la compilación comienza a ejecutarse. Es null mientras el elemento todavía está en la cola.

La siguiente tabla describe todos los campos de entrada disponibles para esta acción.

Aporte	Tipo	Descripción	Ejemplo
authToken	Cadena (secreta)	Requerido. `username:apiToken` codificado en Base64 para la autenticación básica HTTP.	`${{ :secrets:jenkinsAuthToken }}`
url	Cadena	Requerido. URL del servidor de Jenkins.	`https://jenkins.example.com`
queueId	En t	Requerido. ID del elemento de la cola devuelto por `jenkins.job.trigger` . Utilice esto para realizar un seguimiento de la compilación y recuperar el número de compilación una vez que comience la ejecución.	`123`
selectors	Lista	Opcional. Selectores JQ para extraer campos específicos de la respuesta HTTP.	`[{"name": "buildNumber", "expression": ".responseBody \| fromjson.executable.number // null"}]`

La siguiente tabla describe todos los campos de salida devueltos por esta acción.

Producción	Tipo	Descripción
response	Objeto	Detalles del elemento de la cola. `executable.number` contiene el número de compilación una vez que la compilación comienza a ejecutarse —es `null` mientras el elemento todavía está en la cola. `{ "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	Booleano	`true` en caso de éxito, `false` en caso de falla.
errorMessage	Cadena	Mensaje de error si la solicitud falló. `null` en caso de éxito.

Producción

Tipo

Descripción

response

Objeto

Detalles del elemento de la cola. executable.number contiene el número de compilación una vez que la compilación comienza a ejecutarse —es null mientras el elemento todavía está en la cola.

{
  "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

Booleano

true

en caso de éxito,

false

en caso de falla.

errorMessage

Cadena

Mensaje de error si la solicitud falló.

null

en caso de éxito.

El siguiente ejemplo desencadena una compilación y sondea la cola hasta que el número de compilación esté disponible.

Ejemplo de flujo de trabajo
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

Ejemplo de flujo de trabajo

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 una compilación de Jenkins en cola

El identificador de la acción es jenkins.queue.cancel.

Cancela una compilación de Jenkins en cola antes de que comience a ejecutarse. Requiere un queueId obtenido de una llamada jenkins.job.trigger anterior.

Esta acción falla si la compilación ya ha comenzado a ejecutarse. Para detener una compilación que ya está en ejecución, utilice jenkins.job.stop en su lugar.

La siguiente tabla describe todos los campos de entrada disponibles para esta acción.

Aporte	Tipo	Descripción	Ejemplo
authToken	Cadena (secreta)	Requerido. `username:apiToken` codificado en Base64 para la autenticación básica HTTP.	`${{ :secrets:jenkinsAuthToken }}`
url	Cadena	Requerido. URL del servidor de Jenkins.	`https://jenkins.example.com`
queueId	En t	Requerido. ID del elemento de la cola que se va a cancelar. El elemento aún debe estar en la cola y no estar ejecutándose.	`123`
selectors	Lista	Opcional. Selectores JQ para extraer campos específicos de la respuesta HTTP.	`[{"name": "statusCode", "expression": ".statusCode"}]`

La siguiente tabla describe todos los campos de salida devueltos por esta acción.

Producción	Tipo	Descripción
response	Objeto	Jenkins devuelve HTTP 204 (No Content) tras una cancelación exitosa. Jenkins devuelve 404 si no se encuentra el elemento de la cola o si ya ha comenzado a ejecutarse. Ejemplo: `{ "statusCode": 204, "body": "" }`
success	Booleano	`true` en caso de éxito, `false` en caso de falla.
errorMessage	Cadena	Mensaje de error si la cancelación falló. `null` en caso de éxito.

Producción

Tipo

Descripción

response

Objeto

Jenkins devuelve HTTP 204 (No Content) tras una cancelación exitosa. Jenkins devuelve 404 si no se encuentra el elemento de la cola o si ya ha comenzado a ejecutarse. Ejemplo:

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

success

Booleano

true

en caso de éxito,

false

en caso de falla.

errorMessage

Cadena

Mensaje de error si la cancelación falló.

null

en caso de éxito.

El siguiente ejemplo desencadena una compilación de Jenkins y luego la cancela antes de que comience a ejecutarse.

Ejemplo de flujo de trabajo
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

Ejemplo de flujo de trabajo

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

Enumere todos los elementos de la cola de compilación de Jenkins

El identificador de la acción es jenkins.queue.list.

Enumera todos los elementos actualmente en la cola de compilación de Jenkins.

La siguiente tabla describe todos los campos de entrada disponibles para esta acción.

Aporte

Tipo

Descripción

Ejemplo

authToken

Cadena (secreta)

Requerido.

username:apiToken

codificado en Base64 para la autenticación básica HTTP.

${{ :secrets:jenkinsAuthToken }}

url

Cadena

Requerido.

URL del servidor de Jenkins.

https://jenkins.example.com

selectors

Lista

Opcional.

Selectores JQ para extraer campos específicos de la respuesta HTTP.

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

La siguiente tabla describe todos los campos de salida devueltos por esta acción.

Producción	Tipo	Descripción
response	Objeto	Todos los elementos de la cola. Cada elemento incluye `id`, `task` (información del trabajo) y `executable` (información de la compilación una vez que comienza la compilación). `{ "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	Booleano	`true` en caso de éxito, `false` en caso de falla.
errorMessage	Cadena	Mensaje de error si la solicitud falló. `null` en caso de éxito.

Producción

Tipo

Descripción

response

Objeto

Todos los elementos de la cola. Cada elemento incluye id, task (información del trabajo) y executable (información de la compilación una vez que comienza la compilación).

{
  "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

Booleano

true

en caso de éxito,

false

en caso de falla.

errorMessage

Cadena

Mensaje de error si la solicitud falló.

null

en caso de éxito.

El siguiente ejemplo enumera todos los elementos de la cola de compilación de Jenkins y extrae el recuento.

Ejemplo de flujo de trabajo
`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`

Ejemplo de flujo de trabajo

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

Te ofrecemos esta traducción automática para facilitar la lectura.

Requisitos previos.css-21sua1{background:none;border:none;width:0;padding:0;}

Obtener un elemento de la cola de Jenkins

Cancelar una compilación de Jenkins en cola

Enumere todos los elementos de la cola de compilación de Jenkins

Requisitos previos