Cloud Build Badge

Overview

Cloud Build のステータスを表すバッジを生成するアプリケーションです。

生成されるバッジはビルドのステータスに応じて6種類です。

ビルド中：working
ビルドの成功：success
ビルドの失敗：failure
ビルドのキャンセル：cancelled
ビルドのタイムアウト：timeout
ステップのタイムアウト：failed

Requirement

リポジトリの接続やCloud Buildの設定は済んでいることが前提となっています。
未設定の場合は公式ドキュメントなどを参考に設定してください。

なお、接続するリポジトリについてはCloud Source RepositoriesおよびGitHubにて正常に動作することを確認しています。

Setup

Create Bucket

バッジの保存先であるCloud Storageのバケットを作成します。

$ BUCKET_NAME='your-bucket-name'
$ gsutil mb -c standard -l us-central1 gs://${BUCKET_NAME}
$ gsutil iam ch allUsers:objectViewer gs://${BUCKET_NAME}

Deploy Function

バッジを生成するアプリケーションをCloud Functionsへデプロイします。

$ FUNCTION_NAME='any-function-name'
$ BUCKET_NAME='your-bucket-name'
$ gcloud functions deploy ${FUNCTION_NAME} \
  --runtime python38 \
  --entry-point entry_point \
  --trigger-topic cloud-builds \
  --region us-central1 \
  --set-env-vars _CLOUD_BUILD_BADGE_BUCKET=${BUCKET_NAME}

Usage

Generate Badge

Cloud Buildで実行される全てのビルドに対して自動でバッジが生成されます。

Badge Location

Cloud Buildのトリガの起動イベントが「ブランチへのpush」で対象のブランチが1つしか設定されていない場合、もしくはトリガの起動イベントが「タグのpush」の場合はこちらを参照ください。

https://storage.googleapis.com/<BUCKET>/triggers/<TRIGGER>/badge.svg

Cloud Buildのトリガの起動イベントが「ブランチへのpush」で対象のブランチが複数設定されている場合はこちらを参照ください。
なお、ビルドの構成ファイル自体の構文エラー等でビルドが失敗した場合、Cloud Functions内で対象のリポジトリ名／ブランチ名の情報が取得できず、バッジが更新されないため注意してください。

https://storage.googleapis.com/<BUCKET>/repositories/<REPOSITORY>/triggers/<TRIGGER>/branches/<BRANCH>/badge.svg

BUCKET ：Cloud Storageのバケット名。
TRIGGER ：Cloud BuildのトリガID。
REPOSITORY ：ビルド対象のリポジトリ名。
BRANCH ：ビルド対象のブランチ名。

Configuration

設定でバッジの生成を抑制したり、バッジのラベル部分を変更できます。
Cloud Functionsの環境変数、もしくはCloud Buildのトリガの代入変数に値を設定してください。
設定が重複している場合、Cloud Buildのトリガ側の設定値が優先されます。

Variable	Type	Required	Default	Description
_CLOUD_BUILD_BADGE_BUCKET	string	○		バッジの保存先となるCloud Storageのバケット名です。
_CLOUD_BUILD_BADGE_GENERATION	string		`enabled`	バッジの生成に関する設定です。 `enabled` もしくは `disabled` を指定できます。 `enabled` の場合バッジを生成しバケットへ保存します。 `disabled` の場合バッジは生成されません。
_CLOUD_BUILD_BADGE_LABEL	string		`build`	バッジのラベル部分に記載する文言です。
_CLOUD_BUILD_BADGE_LOGO	string			バッジのラベル部分に表示するロゴです。 Data URI形式の画像を指定できます。

jkff-mv/cloud-build-badge