駆け出しのエンジニアではありますが、circleciを導入してみて、ふと「READMEにあるcircle ciのバッジってどうやって表示するんだろう」
と疑問に思って、いろいろ調べてみたものの、なんか情報が古そう(多分circle ci自体のUIが変わったっぽい?)だったので、英語で調べていたら見つかりました。
今回はその備忘録です。
また、時間が経過するとやり方が変わるかもしれないですがその辺はご了承ください。
Status Badgesの表示
Adding Status Badgesと言うCircleCIの公式ドキュメントに方法が記載されています。
ここでも方法を説明します。
# テンプレート
[![<ORG_NAME>](https://circleci.com/<VCS>/<ORG_NAME>/<PROJECT_NAME>.svg?style=svg)](<LINK>)
# 例
[![CircleCI](https://circleci.com/gh/circleci/circleci-docs.svg?style=svg)](https://circleci.com/gh/circleci/circleci-docs)
以下ではマークダウンのURLの書き方についてまとめます。
変数 | 説明 |
---|---|
ORG_NAME | circleCIを導入したプロジェクトのgithubのuser名 |
VCS | VCSプロバイダー。githubなら"gh"、BitBucketなら"bb" |
PROJECT_NAME | プロジェクト名。circleciを導入したもので、ダッシュボードに表示されている |
LINK | ステータスバッジがクリックされたときに表示されるリンク |
僕の場合はこんな感じになりました!!
ちなみに、バッジには様々なスタイルがあるそうで、Shields ioにて、いろいろなスタイルが紹介されています。
変更の方法は、
.svg?style=svg
のstyle=svg
を上記のShields ioで紹介されているものに置き換えるだけです!