Jenkins 작업 액션

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

전제 조건

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

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

Jenkins 작업 트리거

작업 식별자는 jenkins.job.trigger입니다.

선택적 파라미터로 Jenkins 빌드를 트리거합니다. 성공 시 실행이 시작된 후 빌드 진행 상황을 추적하고 빌드 번호를 검색하기 위해 jenkins.queue.getItem와(과) 함께 사용할 수 있는 queueId을(를) 반환합니다.

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

입력	유형	설명	예시
authToken	문자열(시크릿)	필수 항목입니다. HTTP 기본 인증을 위한 Base64 인코딩된 `username:apiToken` 입니다. Configure > API Token 의 Jenkins 사용자 프로필에서 API 토큰을 생성하십시오.	`${{ :secrets:jenkinsAuthToken }}`
URL	문자열	필수 항목입니다. Jenkins 서버 URL.	`https://jenkins.example.com`
jobName	문자열	필수 항목입니다. 트리거할 Jenkins 작업의 이름입니다. 폴더 기반 작업의 경우 슬래시를 구분 기호로 사용하십시오.	`deployments/production/my-job`
매개변수	지도	선택 사항. 파라미터화된 빌드를 위한 핵심 가치 쌍 형태의 빌드 파라미터입니다. 제공된 경우, 작업은 자동으로 `/buildWithParameters` 엔드포인트를 사용합니다.	`{"ENVIRONMENT": "production", "VERSION": "v1.2.3"}`
selectors	목록	선택 사항. 작업 출력에서 특정 필드를 추출하기 위한 JQ 선택자입니다.	`[{"name": "queueId", "expression": ".queueId"}]`

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

산출	유형	설명
queueId	Int	대기열 항목 ID입니다(예: `123` ). 실행이 시작된 후 빌드 진행 상황을 추적하고 빌드 번호를 검색하려면 `jenkins.queue.getItem` 와(과) 함께 사용하십시오.
대기열 URL	문자열	전체 대기열 URL입니다(예: `"http://jenkins.example.com/queue/item/123/"` ).
상태 코드	Int	HTTP 상태 코드입니다. `201` 은(는) 성공적인 트리거를 나타냅니다.
success	부울	`true` 성공 시, 실패 시 `false` 입니다.
errorMessage	문자열	빌드 트리거에 실패한 경우의 오류 메시지입니다. 성공 시 `null` 입니다.

다음 예제는 파라미터화된 Jenkins 빌드를 트리거하고 추적을 위해 대기열 ID를 캡처합니다.

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

워크플로 예

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

Jenkins 빌드 상태 가져오기

작업 식별자는 jenkins.job.getStatus입니다.

Jenkins 작업 빌드의 상태를 가져옵니다. jenkins.job.trigger에 의해 트리거된 빌드를 폴링하려면 이 작업을 사용하십시오.

최신 빌드가 아닌 특정 빌드를 확인하려면 해당 buildNumber을(를) 제공하십시오. 빌드를 트리거한 후 jenkins.queue.getItem (으)로 대기열을 폴링하여 빌드 번호를 가져오십시오.

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

입력	유형	설명	예시
authToken	문자열(시크릿)	필수 항목입니다. HTTP 기본 인증을 위한 Base64로 인코딩된 `username:apiToken` 입니다.	`${{ :secrets:jenkinsAuthToken }}`
URL	문자열	필수 항목입니다. Jenkins 서버 URL.	`https://jenkins.example.com`
jobName	문자열	필수 항목입니다. Jenkins 작업의 이름입니다. 폴더 기반 작업의 경우 슬래시를 구분 기호로 사용하십시오.	`deployments/production/my-job`
buildNumber	Int	선택 사항. 확인할 특정 빌드 번호입니다. 제공되지 않은 경우, 마지막 빌드의 상태를 반환합니다.	`42`
selectors	목록	선택 사항. HTTP 응답에서 특정 필드를 추출하기 위한 JQ 선택자입니다.	`[{"name": "buildStatus", "expression": ".responseBody \| fromjson.result"}]`

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

산출	유형	설명
response	물체	Jenkins API의 빌드 세부 정보입니다. 빌드가 아직 진행 중인 경우 `result` 필드 값은 `SUCCESS`, `FAILURE`, `UNSTABLE`, `ABORTED`, `NOT_BUILT` 또는 `null` 입니다. `{ "number": 42, "result": "SUCCESS", "building": false, "duration": 45000, "timestamp": 1625234567000, "url": "http://jenkins.example.com/job/my-job/42/" }`
success	부울	`true` 성공 시, 실패 시 `false` 입니다.
errorMessage	문자열	요청이 실패한 경우의 오류 메시지. 성공 시 `null` 입니다.

산출

유형

설명

response

물체

Jenkins API의 빌드 세부 정보입니다. 빌드가 아직 진행 중인 경우 result 필드 값은 SUCCESS, FAILURE, UNSTABLE, ABORTED, NOT_BUILT 또는 null 입니다.

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

success

부울

true

성공 시, 실패 시

false

입니다.

errorMessage

문자열

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

null

입니다.

다음 예제는 Jenkins 빌드의 상태를 확인하고 결과에 따라 분기합니다.

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

워크플로 예

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

Jenkins 작업 삭제

작업 식별자는 jenkins.job.delete입니다.

Jenkins 작업 및 모든 빌드 기록을 영구적으로 삭제합니다. 이 작업은 실행 취소할 수 없습니다.

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

입력	유형	설명	예시
authToken	문자열(시크릿)	필수 항목입니다. HTTP 기본 인증을 위한 Base64로 인코딩된 `username:apiToken` 입니다.	`${{ :secrets:jenkinsAuthToken }}`
URL	문자열	필수 항목입니다. Jenkins 서버 URL.	`https://jenkins.example.com`
jobName	문자열	필수 항목입니다. 삭제할 Jenkins 작업의 이름. 폴더 기반 작업의 경우 슬래시를 구분 기호로 사용하십시오.	`temporary/test-job-123`
selectors	목록	선택 사항. HTTP 응답에서 특정 필드를 추출하기 위한 JQ 선택자입니다.	`[{"name": "statusCode", "expression": ".statusCode"}]`

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

산출	유형	설명
response	물체	성공적으로 삭제되면 Jenkins는 HTTP 302(리디렉션)를 반환합니다. 작업이 즉시 제거됩니다. 예: `{ "statusCode": 302, "body": "" }`
success	부울	`true` 성공 시, 실패 시 `false` 입니다.
errorMessage	문자열	삭제에 실패한 경우의 오류 메시지입니다. 성공 시 `null` 입니다.

산출

유형

설명

response

물체

성공적으로 삭제되면 Jenkins는 HTTP 302(리디렉션)를 반환합니다. 작업이 즉시 제거됩니다. 예:

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

success

부울

true

성공 시, 실패 시

false

입니다.

errorMessage

문자열

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

null

입니다.

다음 예제는 임시 Jenkins 작업을 삭제합니다.

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

워크플로 예

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

실행 중인 Jenkins 빌드 중지

작업 식별자는 jenkins.job.stop입니다.

실행 중인 Jenkins 빌드를 중지하거나 중단합니다. 중지되면 Jenkins는 빌드를 ABORTED (으)로 표시합니다.

실행 중인 빌드의 buildNumber이(가) 필요합니다. jenkins.job.trigger을(를) 사용하여 빌드를 트리거한 다음 jenkins.queue.getItem을(를) 폴링하여 가져오십시오.

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

입력	유형	설명	예시
authToken	문자열(시크릿)	필수 항목입니다. HTTP 기본 인증을 위한 Base64로 인코딩된 `username:apiToken` 입니다.	`${{ :secrets:jenkinsAuthToken }}`
URL	문자열	필수 항목입니다. Jenkins 서버 URL.	`https://jenkins.example.com`
jobName	문자열	필수 항목입니다. Jenkins 작업의 이름입니다. 폴더 기반 작업의 경우 슬래시를 구분 기호로 사용하십시오.	`deployments/production/my-job`
buildNumber	Int	필수 항목입니다. 중지할 빌드 번호입니다. 현재 실행 중인 빌드여야 합니다.	`42`
selectors	목록	선택 사항. HTTP 응답에서 특정 필드를 추출하기 위한 JQ 선택자입니다.	`[{"name": "statusCode", "expression": ".statusCode"}]`

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

산출	유형	설명
response	물체	중지 요청이 성공하면 Jenkins는 HTTP 302(리디렉션)를 반환합니다. 예시: `{ "statusCode": 302, "body": "" }`
success	부울	`true` 성공 시, 실패 시 `false` 입니다.
errorMessage	문자열	빌드 중지에 실패할 경우의 오류 메시지입니다. 성공 시 `null` 입니다.

산출

유형

설명

response

물체

중지 요청이 성공하면 Jenkins는 HTTP 302(리디렉션)를 반환합니다. 예시:

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

success

부울

true

성공 시, 실패 시

false

입니다.

errorMessage

문자열

빌드 중지에 실패할 경우의 오류 메시지입니다. 성공 시

null

입니다.

다음 예제는 실행 중인 Jenkins 빌드를 중지합니다.

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

워크플로 예

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

Jenkins 빌드에서 콘솔 출력 가져오기

작업 식별자는 jenkins.job.getConsoleOutput입니다.

Jenkins 빌드에서 콘솔 출력 및 로그를 가져옵니다.

buildNumber이(가) 필요합니다. jenkins.job.trigger을(를) 사용하여 빌드를 트리거한 다음 jenkins.queue.getItem을(를) 폴링하여 가져오십시오.

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

입력	유형	설명	예시
authToken	문자열(시크릿)	필수 항목입니다. HTTP 기본 인증을 위한 Base64로 인코딩된 `username:apiToken` 입니다.	`${{ :secrets:jenkinsAuthToken }}`
URL	문자열	필수 항목입니다. Jenkins 서버 URL.	`https://jenkins.example.com`
jobName	문자열	필수 항목입니다. Jenkins 작업의 이름입니다. 폴더 기반 작업의 경우 슬래시를 구분 기호로 사용하십시오.	`deployments/production/my-job`
buildNumber	Int	필수 항목입니다. 콘솔 출력을 검색할 빌드 번호입니다.	`142`
selectors	목록	선택 사항. HTTP 응답에서 특정 필드를 추출하기 위한 JQ 선택자입니다. 콘솔 출력 텍스트는 `response.body` 에 있습니다.	`[{"name": "buildLogs", "expression": ".responseBody"}]`

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

산출	유형	설명
response	물체	`response.body`에 일반 텍스트로 반환된 콘솔 출력입니다. 선택기를 사용하여 로그에서 특정 정보를 추출하십시오. `{ "body": "Started by user admin\nBuilding in workspace...\n[Pipeline] End of Pipeline\nFinished: SUCCESS", "statusCode": 200 }`
success	부울	`true` 성공 시, 실패 시 `false` 입니다.
errorMessage	문자열	콘솔 출력을 가져오는 데 실패한 경우의 오류 메시지입니다. 성공 시 `null` 입니다.

산출

유형

설명

response

물체

response.body에 일반 텍스트로 반환된 콘솔 출력입니다. 선택기를 사용하여 로그에서 특정 정보를 추출하십시오.

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

success

부울

true

성공 시, 실패 시

false

입니다.

errorMessage

문자열

콘솔 출력을 가져오는 데 실패한 경우의 오류 메시지입니다. 성공 시

null

입니다.

다음 예제는 빌드 로그를 검색하고 오류를 확인합니다.

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

워크플로 예

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

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

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

Jenkins 작업 트리거

Jenkins 빌드 상태 가져오기

Jenkins 작업 삭제

실행 중인 Jenkins 빌드 중지

Jenkins 빌드에서 콘솔 출력 가져오기

전제 조건