メインコンテンツまでスキップ

プロジェクトステータスバッジの埋め込み

Bitriseステータスバッジをサイトに埋め込んで、訪問者に最新のビルドの状態を表示できます。ビルドの状態は、ビルド元のリポジトリブランチに関わらず任意のビルドを表示することも、特定のブランチを選択して表示することもできます。

埋め込みコードは、status image API tokenを使ってアプリのProject settingsページから取得できます。

  1. プロジェクトに対するAdminのロールを持つユーザー、またはEdit workflow権限を持つカスタムロールを持つユーザーで、Bitrise上のプロジェクトを開きます。

  2. プロジェクトのメインページで、Project settingsボタンをクリックします。

  3. 左側でBuildsを選択します。

  4. Build status badgeセクションまでスクロールし、Get codeをクリックします。

    build-status-badge.png

  5. 必要に応じて、Branchフィールドにbranch nameを入力します。

    有効なbranch nameを入力すると、そのブランチのビルドの状態が表示されます。フィールドを空欄のままにすると、プロジェクトの任意のビルドの状態が表示されます。

    status-badge-dialog.png

  6. Formatメニューで埋め込みコードの形式を選択します。Image URL(画像への単純なHTTPS URL)またはMarkdownを選択できます。

  7. Embedセクションから埋め込みコードをコピーします。

  8. コードをサイトに貼り付けます。

status image API tokenClick to copy link​

status image API tokenは、ステータスバッジの更新にのみ使用できる特別なトークンです。このトークンでは他の情報を取得することはできません。単純なJSONオブジェクトを返します。例えば、最新のビルドが成功している場合は次のようになります。

{ "status": "success" }

考えられるステータスのレスポンスは次のとおりです。

  • success: 直前に完了したビルドが成功した場合。
  • error: 直前に完了したビルドが失敗または中止された場合。
  • unknown: それ以外の場合。例えば、完了したビルドがない場合など。