[小ネタ] CodeBuild の最新ビルド結果を GitHub リポジトリに表示する(CodeBuild のバッジアイコン)

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

ども、藤本です。

今回紹介するのはタイトルから少し分かりづらいかもしれませんが、よく GitHub リポジトリの README.md に貼られているバッジの CodeBuild 版です。↓の画像のようなやつ。↓のバッジは左から Travis CI、Codecov、Read the Docs のバッジです。

このバッジ機能のリリース自体は 2017/11/22にリリースにされています。

概要

CodeBuild は CodeCommit、S3、GitHub、BitBucket にあるソースコードをコンパイルしたり、スタイルチェックしたり、ユニットテストしたりできるビルドサービスです。CodeBuild のビルド結果はマネジメントコンソール(WEB GUI)やSDK、CLIなど様々な方法で確認することができます。ただビルドのステータスを見るには AWS にログインできる必要があります。README.md にこのアイコンを表示しておくことでリポジトリの最新のビルド結果を知ることができます。あと見栄えがよくなります。

設定方法

画像を発行するにはバッジを有効化する必要があります。ビルドプロジェクト作成時に指定することができます。

既存のビルドプロジェクトを変更して有効化することもできます。

ビルドプロジェクトの詳細から URL を取得することができます。

設定はこれだけです。

確認

GitHub リポジトリの README.md にバッジの URL を貼り付けて、GitHub の Web画面から見れるようにしましょう。上記で参照した URL をコピーします。README.md に下記のように追記します。

![Build Status](https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoieGpMb3ZxM1VuTzVvNlFjL2dtakhsVTNGV242MmpncXliTldobmdTMXViODhJS3lTSyt3OWhEdURuUlJ5VGV4TE0zdVA2MlNjVkZhcWt2Ky9iOXp5N2MwPSIsIml2UGFyYW1ldGVyU3BlYyI6IkFCL1FpUTg1dnhlVkNkOW8iLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)

GitHub リポジトリにプッシュします。

未ビルド

CodeBuild のビルドプロジェクトを作成して、まだ一回もビルドしていない状態です。

Unknownというステータスの画像が表示されます。

ビルド中

CodeBuild のビルドを回してみましょう。ビルドプロジェクトの画面から Start build でビルドを実行します。

ビルド中はin progressというステータスの画像が表示されます。

ビルド成功

ビルド完了を待ちます。Succeed ステータスになりました。

ビルド成功はPassingというステータスの画像が表示されます。

ビルド失敗

ちなみに失敗するとFailingというステータスの画像が表示されます。

まとめ

いかがでしたでしょうか?地味な機能ではありますが、、見栄え大事。