Acciones de trabajo de Jenkins

Esta página proporciona una referencia de las acciones de trabajos de Jenkins disponibles en el catálogo de acciones de automatización de flujo de trabajo. Utilice estas acciones para activar y administrar las compilaciones de Jenkins.

Requisitos previos

Antes de usar las acciones de trabajo de Jenkins en la automatización del flujo 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> }}.
Para trabajos basados en carpetas, la ruta completa de la carpeta al trabajo usando / como separador (por ejemplo, deployments/production/my-job).

Desencadenar un trabajo de Jenkins

El identificador de la acción es jenkins.job.trigger.

Desencadena una compilación de Jenkins con parámetros opcionales. En caso de éxito, devuelve un queueId que puede usar con jenkins.queue.getItem para realizar un seguimiento del progreso de la compilación y recuperar el número de compilación una vez que comienza la ejecución.

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. Genere el token de la API desde el perfil de usuario de Jenkins en Configure > API Token .	`${{ :secrets:jenkinsAuthToken }}`
url	Cadena	Requerido. URL del servidor de Jenkins.	`https://jenkins.example.com`
jobName	Cadena	Requerido. Nombre del trabajo de Jenkins a ejecutar. Para los trabajos basados en carpetas, use barras diagonales como separadores.	`deployments/production/my-job`
parámetro	Mapa	Opcional. Parámetros de compilación como pares de valor principal para compilaciones parametrizadas. Cuando se proporciona, la acción usa el extremo `/buildWithParameters` automáticamente.	`{"ENVIRONMENT": "production", "VERSION": "v1.2.3"}`
selectors	Lista	Opcional. Selectores JQ para extraer campos específicos de la salida de la acción.	`[{"name": "queueId", "expression": ".queueId"}]`

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

Producción	Tipo	Descripción
queueId	En t	ID del elemento de la cola, por ejemplo, `123` . Úselo con `jenkins.queue.getItem` para realizar un seguimiento del progreso de la compilación y obtener el número de compilación una vez que se inicie la ejecución.
queueUrl	Cadena	URL completa de la cola, por ejemplo, `"http://jenkins.example.com/queue/item/123/"` .
código de estado	En t	Código de estado HTTP. `201` indica una activación exitosa.
success	Booleano	`true` en caso de éxito, `false` en caso de falla.
errorMessage	Cadena	Mensaje de error si la compilación no se pudo activar. `null` en caso de éxito.

El siguiente ejemplo activa una compilación parametrizada de Jenkins y captura el ID de la cola para su seguimiento.

Ejemplo de flujo de trabajo
`name: trigger-jenkins-build description: 'Trigger a parameterized Jenkins build' steps: - name: trigger_build type: action action: jenkins.job.trigger version: 1 inputs: authToken: ${{ :secrets:jenkinsAuthToken }} url: "https://jenkins.example.com" jobName: "deployments/production-deploy" parameters: ENVIRONMENT: "production" VERSION: "v1.2.3" selectors: - name: "queueId" expression: ".queueId" next: end`

Ejemplo de flujo de trabajo

name: trigger-jenkins-build
description: 'Trigger a parameterized Jenkins build'
steps:
  - name: trigger_build
    type: action
    action: jenkins.job.trigger
    version: 1
    inputs:
      authToken: ${{ :secrets:jenkinsAuthToken }}
      url: "https://jenkins.example.com"
      jobName: "deployments/production-deploy"
      parameters:
        ENVIRONMENT: "production"
        VERSION: "v1.2.3"
      selectors:
        - name: "queueId"
          expression: ".queueId"
    next: end

Obtener el estado de una compilación de Jenkins

El identificador de la acción es jenkins.job.getStatus.

Obtiene el estado de la compilación de un trabajo de Jenkins. Use esta acción para sondear una compilación iniciada por jenkins.job.trigger.

Para comprobar una compilación específica en lugar de la última, proporcione su buildNumber. Obtenga el número de compilación sondeando la cola con jenkins.queue.getItem después de desencadenar la compilación.

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`
jobName	Cadena	Requerido. Nombre del trabajo de Jenkins. Para los trabajos basados en carpetas, utilice barras diagonales como separadores.	`deployments/production/my-job`
buildNumber	En t	Opcional. Número de compilación específico para comprobar. Si no se proporciona, devuelve el estado de la última compilación.	`42`
selectors	Lista	Opcional. Selectores JQ para extraer campos específicos de la respuesta HTTP.	`[{"name": "buildStatus", "expression": ".responseBody \| fromjson.result"}]`

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

Producción	Tipo	Descripción
response	Objeto	Detalles de la compilación de la API de Jenkins. Los valores del campo `result` son `SUCCESS`, `FAILURE`, `UNSTABLE`, `ABORTED`, `NOT_BUILT` o `null` si la compilación aún está en curso. `{ "number": 42, "result": "SUCCESS", "building": false, "duration": 45000, "timestamp": 1625234567000, "url": "http://jenkins.example.com/job/my-job/42/" }`
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 de la compilación de la API de Jenkins. Los valores del campo result son SUCCESS, FAILURE, UNSTABLE, ABORTED, NOT_BUILT o null si la compilación aún está en curso.

{
  "number": 42,
  "result": "SUCCESS",
  "building": false,
  "duration": 45000,
  "timestamp": 1625234567000,
  "url": "http://jenkins.example.com/job/my-job/42/"
}

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 verifica el estado de una compilación de Jenkins y se bifurca según el resultado.

Ejemplo de flujo de trabajo
name: check-jenkins-build-status description: 'Check the status of a Jenkins build and branch on result' steps: - name: check_build_status type: action action: jenkins.job.getStatus version: 1 inputs: authToken: ${{ :secrets:jenkinsAuthToken }} url: "https://jenkins.example.com" jobName: "deployments/production-deploy" buildNumber: 42 selectors: - name: buildStatus expression: ".responseBody \| fromjson.result" - name: isBuilding expression: ".responseBody \| fromjson.building" - name: handle_result type: switch switch: - condition: ${{ .steps.check_build_status.outputs.buildStatus == "SUCCESS" }} next: notify_success next: notify_failure

Ejemplo de flujo de trabajo

name: check-jenkins-build-status
description: 'Check the status of a Jenkins build and branch on result'
steps:
  - name: check_build_status
    type: action
    action: jenkins.job.getStatus
    version: 1
    inputs:
      authToken: ${{ :secrets:jenkinsAuthToken }}
      url: "https://jenkins.example.com"
      jobName: "deployments/production-deploy"
      buildNumber: 42
      selectors:
        - name: buildStatus
          expression: ".responseBody | fromjson.result"
        - name: isBuilding
          expression: ".responseBody | fromjson.building"

  - name: handle_result
    type: switch
    switch:
      - condition: ${{ .steps.check_build_status.outputs.buildStatus == "SUCCESS" }}
        next: notify_success
    next: notify_failure

Eliminar un trabajo de Jenkins

El identificador de la acción es jenkins.job.delete.

Elimina permanentemente un trabajo de Jenkins y todo su historial de compilaciones. Esta operación no se puede deshacer.

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`
jobName	Cadena	Requerido. Nombre del trabajo de Jenkins a eliminar. Para los trabajos basados en carpetas, utilice barras diagonales como separadores.	`temporary/test-job-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 302 (redirección) tras una eliminación exitosa. El trabajo se elimina inmediatamente. Ejemplo: `{ "statusCode": 302, "body": "" }`
success	Booleano	`true` en caso de éxito, `false` en caso de falla.
errorMessage	Cadena	Mensaje de error si falló la eliminación. `null` en caso de éxito.

Producción

Tipo

Descripción

response

Objeto

Jenkins devuelve HTTP 302 (redirección) tras una eliminación exitosa. El trabajo se elimina inmediatamente. Ejemplo:

{ "statusCode": 302, "body": "" }

success

Booleano

true

en caso de éxito,

false

en caso de falla.

errorMessage

Cadena

Mensaje de error si falló la eliminación.

null

en caso de éxito.

El siguiente ejemplo elimina un trabajo temporal de Jenkins.

Ejemplo de flujo de trabajo
`name: cleanup-jenkins-job description: 'Delete a temporary Jenkins job' steps: - name: delete_job type: action action: jenkins.job.delete version: 1 inputs: authToken: ${{ :secrets:jenkinsAuthToken }} url: "https://jenkins.example.com" jobName: "temporary/test-job-123" next: end`

Ejemplo de flujo de trabajo

name: cleanup-jenkins-job
description: 'Delete a temporary Jenkins job'
steps:
  - name: delete_job
    type: action
    action: jenkins.job.delete
    version: 1
    inputs:
      authToken: ${{ :secrets:jenkinsAuthToken }}
      url: "https://jenkins.example.com"
      jobName: "temporary/test-job-123"
    next: end

Detenga una compilación de Jenkins en ejecución

El identificador de la acción es jenkins.job.stop.

Detiene o aborta una compilación de Jenkins en ejecución. Jenkins marca la compilación como ABORTED una vez detenida.

Requiere el buildNumber de la compilación en ejecución. Obténgalo activando la compilación con jenkins.job.trigger y luego consultando jenkins.queue.getItem.

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`
jobName	Cadena	Requerido. Nombre del trabajo de Jenkins. Para los trabajos basados en carpetas, utilice barras diagonales como separadores.	`deployments/production/my-job`
buildNumber	En t	Requerido. Número de compilación a detener. Debe ser una compilación en ejecución.	`42`
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 302 (redirección) en una solicitud de detención exitosa. Ejemplo: `{ "statusCode": 302, "body": "" }`
success	Booleano	`true` en caso de éxito, `false` en caso de falla.
errorMessage	Cadena	Mensaje de error si no se pudo detener la compilación. `null` en caso de éxito.

Producción

Tipo

Descripción

response

Objeto

Jenkins devuelve HTTP 302 (redirección) en una solicitud de detención exitosa. Ejemplo:

{ "statusCode": 302, "body": "" }

success

Booleano

true

en caso de éxito,

false

en caso de falla.

errorMessage

Cadena

Mensaje de error si no se pudo detener la compilación.

null

en caso de éxito.

El siguiente ejemplo detiene una compilación de Jenkins en ejecución.

Ejemplo de flujo de trabajo
`name: stop-jenkins-build description: 'Stop a running Jenkins build' steps: - name: stop_build type: action action: jenkins.job.stop version: 1 inputs: authToken: ${{ :secrets:jenkinsAuthToken }} url: "https://jenkins.example.com" jobName: "deployments/production-deploy" buildNumber: 42 next: end`

Ejemplo de flujo de trabajo

name: stop-jenkins-build
description: 'Stop a running Jenkins build'
steps:
  - name: stop_build
    type: action
    action: jenkins.job.stop
    version: 1
    inputs:
      authToken: ${{ :secrets:jenkinsAuthToken }}
      url: "https://jenkins.example.com"
      jobName: "deployments/production-deploy"
      buildNumber: 42
    next: end

Obtener la salida de la consola de una compilación de Jenkins

El identificador de la acción es jenkins.job.getConsoleOutput.

Recupera la salida de la consola y los logs de una compilación de Jenkins.

Requiere el buildNumber. Obténgalo activando la compilación con jenkins.job.trigger y luego consultando jenkins.queue.getItem.

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`
jobName	Cadena	Requerido. Nombre del trabajo de Jenkins. Para los trabajos basados en carpetas, utilice barras diagonales como separadores.	`deployments/production/my-job`
buildNumber	En t	Requerido. Número de compilación del cual recuperar la salida de la consola.	`142`
selectors	Lista	Opcional. Selectores JQ para extraer campos específicos de la respuesta HTTP. El texto de salida de la consola está en `response.body` .	`[{"name": "buildLogs", "expression": ".responseBody"}]`

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

Producción	Tipo	Descripción
response	Objeto	Salida de la consola devuelta como texto sin formato en `response.body`. Utilice selectores para extraer información específica de los logs. `{ "body": "Started by user admin\nBuilding in workspace...\n[Pipeline] End of Pipeline\nFinished: SUCCESS", "statusCode": 200 }`
success	Booleano	`true` en caso de éxito, `false` en caso de falla.
errorMessage	Cadena	Mensaje de error si falló la recuperación de la salida de la consola. `null` en caso de éxito.

Producción

Tipo

Descripción

response

Objeto

Salida de la consola devuelta como texto sin formato en response.body. Utilice selectores para extraer información específica de los logs.

{
  "body": "Started by user admin\nBuilding in workspace...\n[Pipeline] End of Pipeline\nFinished: SUCCESS",
  "statusCode": 200
}

success

Booleano

true

en caso de éxito,

false

en caso de falla.

errorMessage

Cadena

Mensaje de error si falló la recuperación de la salida de la consola.

null

en caso de éxito.

El siguiente ejemplo recupera los logs de compilación y comprueba si hay errores.

Ejemplo de flujo de trabajo
name: get-jenkins-build-logs description: 'Retrieve Jenkins build logs and check for errors' steps: - name: get_build_logs type: action action: jenkins.job.getConsoleOutput version: 1 inputs: authToken: ${{ :secrets:jenkinsAuthToken }} url: "https://jenkins.example.com" jobName: "deployments/production-deploy" buildNumber: 142 selectors: - name: buildLogs expression: ".responseBody" - name: hasErrors expression: ".responseBody \| contains(\"ERROR\") or contains(\"FAILED\")" - name: check_for_errors type: switch switch: - condition: ${{ .steps.get_build_logs.outputs.hasErrors }} next: handle_error next: end

Ejemplo de flujo de trabajo

name: get-jenkins-build-logs
description: 'Retrieve Jenkins build logs and check for errors'
steps:
  - name: get_build_logs
    type: action
    action: jenkins.job.getConsoleOutput
    version: 1
    inputs:
      authToken: ${{ :secrets:jenkinsAuthToken }}
      url: "https://jenkins.example.com"
      jobName: "deployments/production-deploy"
      buildNumber: 142
      selectors:
        - name: buildLogs
          expression: ".responseBody"
        - name: hasErrors
          expression: ".responseBody | contains(\"ERROR\") or contains(\"FAILED\")"

  - name: check_for_errors
    type: switch
    switch:
      - condition: ${{ .steps.get_build_logs.outputs.hasErrors }}
        next: handle_error
    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;}

Desencadenar un trabajo de Jenkins

Obtener el estado de una compilación de Jenkins

Eliminar un trabajo de Jenkins

Detenga una compilación de Jenkins en ejecución

Obtener la salida de la consola de una compilación de Jenkins

Requisitos previos