소개

Jenkins CLI를 이용해 빌드 표시명, 설명을 설정하는 방법에 대해 조사했으므로 비망록으로 투고하겠습니다.

하고 싶었던 일

Jenkins 빌드 중에 표시 이름, 설명 업데이트

POST (curl 명령 등)를 사용하지 않고 실현

Jenkins CLI 배포 위치

POST (curl 명령 등)를 이용하지 않고 빌드 표시 이름, 설명을 갱신하기 위해 Jenkins CLI를 이용했습니다.

Jenkins CLI는 JENKINS_HOME 아래의 war/WEB-INF/jenkins-cli.jar에 있습니다.http://<Jenkinsのアドレス：ポート>/cli로 이동하여 Jenkins CLI 페이지에서 DL할 수도 있습니다.

Jenkins CLI 페이지에서 사용 가능한 명령에 대한 도움말을 볼 수도 있습니다.

-s 옵션 정보

도움말 등에서는 -s 옵션으로 Jenkins의 URL을 지정하고 있습니다만, Jenkinsの管理 > システムの設定 > Jenkinの位置 > Jenkins URL 가 설정 끝나면 생략 가능합니다.



JenkinsURL 설정되지 않음

$ java -jar jenkins-cli.jar -s http://<Jenkinsのアドレス：ポート> help

JenkinsURL 설정됨

$ java -jar jenkins-cli.jar help

명령

Jenkins CLI 페이지에 빌드 표시 이름, 설명을 설정하는 방법이 나와 있으므로 이것을 참고로 쉘 스크립트를 설정합니다.

빌드 표시 이름 (set-build-display-name)

java -jar jenkins-cli.jar -s http://xxx.xxx.xxx.xxx/ set-build-display-name JOB BUILD# DISPLAYNAME
ビルドの名称を設定します。

 JOB         : Name of the job to build
 BUILD#      : Number of the build
 DISPLAYNAME : DisplayName to be set. '-' to read from stdin.

빌드 설명(set-build-description)

java -jar jenkins-cli.jar -s http://xxx.xxx.xxx.xxx/ set-build-description JOB BUILD# DESCRIPTION
ビルドの説明を設定します。

 JOB         : Name of the job to build
 BUILD#      : Number of the build
 DESCRIPTION : Description to be set. '=' to read from stdin.

쉘 스크립트

이번에는 빌드하고 있는 작업 자체의 표시명, 설명을 갱신하기 때문에 ビルドから利用可能な環境変数 를 이용하여 다음과 같은 쉘 스크립트를 설정했습니다.

JENKINS_CLI=$JENKINS_HOME/war/WEB-INF/jenkins-cli.jar

java -jar $JENKINS_CLI set-build-display-name $JOB_NAME $BUILD_NUMBER "設定したいビルド表示名"
java -jar $JENKINS_CLI set-build-description $JOB_NAME $BUILD_NUMBER "設定したいビルド説明"

빌드를 실행하면ビルド履歴에 쉘 스크립트로 설정한 표시명, 설명이 표시되게 되었습니다.