Jenkins 큐 액션

이 페이지는 워크플로우 자동화 액션 카탈로그에서 사용할 수 있는 Jenkins 큐 액션에 대한 참조를 제공합니다. 이 액션을 사용하여 Jenkins 빌드 큐에서 대기 중인 빌드를 검사하고 관리하십시오.

전제 조건

워크플로우 자동화에서 Jenkins 큐 액션을 사용하기 전에 다음이 필요합니다:

HTTPS를 통해 뉴렐릭 워크플로우 자동화에서 연결할 수 있는 Jenkins 서버입니다. Jenkins 인스턴스가 방화벽 뒤에 있거나 프라이빗 네트워크에 있는 경우, 뉴렐릭 워크플로우 자동화로부터의 인바운드 액세스를 허용하십시오.
워크플로우가 실행되는 계정의 Jenkins API 토큰입니다. Jenkins 사용자 프로필에서 생성하십시오: Configure > API Token > Add new Token.
username:apiToken의 Base64 인코딩 값을 포함하는 뉴렐릭 Secrets Service의 시크릿입니다. 워크플로우에서 이를 ${{ :secrets:<keyName> }}(으)로 참조하십시오.

Jenkins 대기열 항목 가져오기

작업 식별자는 jenkins.queue.getItem입니다.

실행이 시작되면 빌드 번호를 포함한 대기열 항목 세부 정보를 가져옵니다. 다른 작업 액션에 필요한 빌드 번호를 검색하려면 jenkins.job.trigger (으)로 빌드를 트리거한 후 이 액션을 사용하여 대기열을 폴링하십시오.

빌드 실행이 시작되면 응답의 executable.number 필드에 빌드 번호가 포함됩니다. 항목이 아직 대기열에 있는 동안에는 null 입니다.

다음 표는 이 작업에 사용할 수 있는 모든 입력 필드를 설명합니다.

입력	유형	설명	예시
authToken	문자열(시크릿)	필수 항목입니다. HTTP 기본 인증을 위한 Base64로 인코딩된 `username:apiToken` 입니다.	`${{ :secrets:jenkinsAuthToken }}`
URL	문자열	필수 항목입니다. Jenkins 서버 URL.	`https://jenkins.example.com`
queueId	Int	필수 항목입니다. `jenkins.job.trigger` 에서 반환된 대기열 항목 ID입니다. 이를 사용하여 빌드를 추적하고 실행이 시작되면 빌드 번호를 가져오십시오.	`123`
selectors	목록	선택 사항. HTTP 응답에서 특정 필드를 추출하기 위한 JQ 선택자입니다.	`[{"name": "buildNumber", "expression": ".responseBody \| fromjson.executable.number // null"}]`

다음 표는 이 작업에서 반환된 모든 출력 필드를 설명합니다.

산출	유형	설명
response	물체	대기열 항목 세부 정보입니다. 빌드 실행이 시작되면 `executable.number`에 빌드 번호가 포함됩니다 ― 항목이 아직 대기열에 있는 동안에는 `null` 입니다. `{ "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	부울	`true` 성공 시, 실패 시 `false` 입니다.
errorMessage	문자열	요청이 실패한 경우의 오류 메시지. 성공 시 `null` 입니다.

산출

유형

설명

response

물체

대기열 항목 세부 정보입니다. 빌드 실행이 시작되면 executable.number에 빌드 번호가 포함됩니다 ― 항목이 아직 대기열에 있는 동안에는 null 입니다.

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

부울

true

성공 시, 실패 시

false

입니다.

errorMessage

문자열

요청이 실패한 경우의 오류 메시지. 성공 시

null

입니다.

다음 예제는 빌드를 트리거하고 빌드 번호를 사용할 수 있을 때까지 대기열을 폴링합니다.

워크플로 예
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

워크플로 예

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

대기열에 있는 Jenkins 빌드 취소

작업 식별자는 jenkins.queue.cancel입니다.

대기 중인 Jenkins 빌드가 실행되기 전에 취소합니다. 이전 jenkins.job.trigger 호출에서 얻은 queueId이(가) 필요합니다.

빌드가 이미 실행되기 시작한 경우 이 액션은 실패합니다. 이미 실행 중인 빌드를 중지하려면 대신 jenkins.job.stop을(를) 사용하십시오.

다음 표는 이 작업에 사용할 수 있는 모든 입력 필드를 설명합니다.

입력	유형	설명	예시
authToken	문자열(시크릿)	필수 항목입니다. HTTP 기본 인증을 위한 Base64로 인코딩된 `username:apiToken` 입니다.	`${{ :secrets:jenkinsAuthToken }}`
URL	문자열	필수 항목입니다. Jenkins 서버 URL.	`https://jenkins.example.com`
queueId	Int	필수 항목입니다. 취소할 큐 항목 ID입니다. 항목은 여전히 큐에 있어야 하며 아직 실행 중이 아니어야 합니다.	`123`
selectors	목록	선택 사항. HTTP 응답에서 특정 필드를 추출하기 위한 JQ 선택자입니다.	`[{"name": "statusCode", "expression": ".statusCode"}]`

다음 표는 이 작업에서 반환된 모든 출력 필드를 설명합니다.

산출	유형	설명
response	물체	취소에 성공하면 Jenkins는 HTTP 204(No Content)를 반환합니다. 대기열 항목을 찾을 수 없거나 이미 실행이 시작된 경우 Jenkins는 404를 반환합니다. 예: `{ "statusCode": 204, "body": "" }`
success	부울	`true` 성공 시, 실패 시 `false` 입니다.
errorMessage	문자열	취소에 실패한 경우의 오류 메시지입니다. 성공 시 `null` 입니다.

산출

유형

설명

response

물체

취소에 성공하면 Jenkins는 HTTP 204(No Content)를 반환합니다. 대기열 항목을 찾을 수 없거나 이미 실행이 시작된 경우 Jenkins는 404를 반환합니다. 예:

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

success

부울

true

성공 시, 실패 시

false

입니다.

errorMessage

문자열

취소에 실패한 경우의 오류 메시지입니다. 성공 시

null

입니다.

다음 예제는 Jenkins 빌드를 트리거한 다음 실행이 시작되기 전에 취소합니다.

워크플로 예
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

워크플로 예

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

Jenkins 빌드 대기열의 모든 항목 나열

작업 식별자는 jenkins.queue.list입니다.

현재 Jenkins 빌드 대기열에 있는 모든 항목을 나열합니다.

다음 표는 이 작업에 사용할 수 있는 모든 입력 필드를 설명합니다.

입력

유형

설명

예시

authToken

문자열(시크릿)

필수 항목입니다.

HTTP 기본 인증을 위한 Base64로 인코딩된

username:apiToken

입니다.

${{ :secrets:jenkinsAuthToken }}

URL

문자열

필수 항목입니다.

Jenkins 서버 URL.

https://jenkins.example.com

selectors

선택 사항.

HTTP 응답에서 특정 필드를 추출하기 위한 JQ 선택자입니다.

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

다음 표는 이 작업에서 반환된 모든 출력 필드를 설명합니다.

산출	유형	설명
response	물체	모든 대기열 항목입니다. 각 항목에는 `id`, `task` (작업 정보) 및 `executable` (빌드가 시작된 후의 빌드 정보)가 포함됩니다. `{ "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	부울	`true` 성공 시, 실패 시 `false` 입니다.
errorMessage	문자열	요청이 실패한 경우의 오류 메시지. 성공 시 `null` 입니다.

산출

유형

설명

response

물체

모든 대기열 항목입니다. 각 항목에는 id, task (작업 정보) 및 executable (빌드가 시작된 후의 빌드 정보)가 포함됩니다.

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

부울

true

성공 시, 실패 시

false

입니다.

errorMessage

문자열

요청이 실패한 경우의 오류 메시지. 성공 시

null

입니다.

다음 예제는 Jenkins 빌드 대기열의 모든 항목을 나열하고 개수를 추출합니다.

워크플로 예
`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`

워크플로 예

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

사용자의 편의를 위해 제공되는 기계 번역입니다.

전제 조건.css-21sua1{background:none;border:none;width:0;padding:0;}

Jenkins 대기열 항목 가져오기

대기열에 있는 Jenkins 빌드 취소

Jenkins 빌드 대기열의 모든 항목 나열

전제 조건