Search Results for ""

ステータス バッジの追加

プロジェクトのビルド ステータス (成功または失敗) を表示するバッジを README または他のドキュメントに作成する方法について説明します。

概要

ステータス バッジは、一般にプロジェクトの README に埋め込まれていますが、どの Web ドキュメントにも配置できます。 CircleCI では、ステータス バッジの埋め込みコードを生成するツールが提供されています。 デフォルトで、バッジにはプロジェクトのデフォルト ブランチのステータスが表示されますが、他のブランチを選択することも可能です。

以下の形式のコードを生成できます。

  • 画像 URL
  • Markdown
  • Textile
  • Rdoc
  • AsciiDoc
  • reStructuredText
  • pod

手順

  1. ジョブ ページの右上にある歯車アイコンをクリックして、プロジェクトの設定ページを開きます。
  2. [Notifications (通知)] セクションの [Status Badges (ステータス バッジ)] をクリックします。
  3. デフォルトで、バッジにはプロジェクトのデフォルト ブランチのステータスが表示されます。 別のブランチのステータスを表示する場合は、[Branch (ブランチ)] ドロップダウン メニューから選択します。
  4. (オプション) プライベート プロジェクトでは、プロジェクト API トークンを作成する必要があります。
  5. (オプション) 前の手順でトークンを作成した場合、[API Token (API トークン)] ドロップダウン メニューで作成したトークンを選択します。
  6. [Embed Code (埋め込みコード)] ドロップダウン メニューで目的の言語を選択します。
  7. 生成されたリンクをコピーして、ステータス バッジを表示するドキュメントに貼り付けます。

カスタマイズ

デフォルトのステータス バッジでは物足りないという場合は、Shields スタイルを使用できます。 Shield スタイルを使用するには、前述の手順で生成したリンクの style=svgstyle=shield に置き換えます。

関連項目

ステータス