• プロジェクト・バッジ
• グループバッジ
• プレースホルダー
• API

バッジ

GitLab 10.7から導入されました。

バッジは、プロジェクトに関する情報を凝縮して表示する統一された方法です。 バッジは小さな画像と、その画像が指す URL で構成されます。 バッジの例としては、パイプラインの状況、テストカバレッジ、プロジェクトのメンテナーへの連絡方法などがあります。

プロジェクト・バッジ

バッジはメンテナーやオーナーがプロジェクトに追加することができ、プロジェクトの概要ページに表示されます。 複数のプロジェクトに同じバッジを追加する必要がある場合は、グループレベルで追加するとよいでしょう。

プロジェクトに新しいバッジを追加するには：

1. プロジェクトの「設定」>「一般」>「バッジ」を開きます。
2. リンク」の下に、バッジが指すべきURLを入力し、「バッジ画像URL」の下に、表示されるべき画像のURLを入力します。
3. バッジを追加ボタンをクリックして、バッジを送信します。

プロジェクトにバッジを追加した後、フォームの下のリストに表示されます。 バッジの横にあるペンのアイコンをクリックして編集したり、ゴミ箱のアイコンをクリックして削除することができます。

グループに関連付けられたバッジは、グループレベルでのみ編集または削除できます。

グループバッジ

バッジはグループに追加することができ、そのグループの下にあるすべてのプロジェクトの概要ページに表示されます。 この場合、プロジェクトレベルで編集したり削除したりすることはできません。 プロジェクトごとに個別のバッジが必要な場合は、プロジェクトレベルでバッジを追加するか、プレースホルダーを使用することを検討してください。

グループに新しいバッジを追加するには：

1. グループの「設定」>「一般」>「バッジ」を開きます。
2. リンク」の下に、バッジが指すべきURLを入力し、「バッジ画像URL」の下に、表示されるべき画像のURLを入力します。
3. バッジを追加ボタンをクリックして、バッジを送信します。

グループにバッジを追加した後、フォームの下のリストにバッジが表示されます。 バッジの横にあるペンのアイコンをクリックするとバッジを編集することができ、ゴミ箱のアイコンをクリックするとバッジを削除することができます。

プロジェクトに直接関連するバッジは、プロジェクトレベルで設定できます。

プレースホルダー

バッジが指すURLと画像のURLには、バッジを表示する際に評価されるプレースホルダを含めることができます。 以下のプレースホルダが利用可能です：

• %{project_path}親グループを含むプロジェクトのパス。
• %{project_id}プロジェクトに関連付けられたデータベースID
• %{default_branch}プロジェクトのリポジトリに設定されたデフォルトブランチ名
• %{commit_sha}プロジェクトのリポジトリのデフォルトブランチへの直近のコミットの ID。

API

GitLab API を使ってバッジを設定することもできます。 設定と同様に、バッジのエンドポイントはプロジェクトレベルとグループレベルで区別されています。