Bencher ステータスバッジの追加方法

Bencher ステータスバッジは、プロジェクトにアクティブなアラートがあるかどうかを示します:

• プロジェクトにアクティブなアラートがない場合は Bencher | passing
• プロジェクトにアクティブなアラートが 1 つ以上ある場合は Bencher | failing

アラートは、新しい結果がしきい値を超えたときに生成されます。 アラートは却下またはミュートされるまでアクティブなままです。 アーカイブされたブランチ、テストベッド、またはメジャーのアラートは、 Bencher コンソールのプロジェクトの Alerts タブと同じく、カウントされません。

README にバッジを追加する

次の Markdown を README に追加します。<project> はプロジェクトのスラッグまたは UUID です:

![Bencher](https://api.bencher.dev/v0/projects/<project>/badge)

1 つのブランチのアラートだけをカウントするには、ブランチの名前、スラッグ、または UUID を指定した branch クエリパラメータを追加します。 同様に、testbed クエリパラメータは 1 つのテストベッドのアラートだけをカウントします。 名前に含まれる / は %2F とエンコードできます（例: ?branch=release%2F1.0）。

![Bencher](https://api.bencher.dev/v0/projects/<project>/badge?branch=main)

バッジを Bencher コンソールのプロジェクトのアラートにリンクするには:

[![Bencher](https://api.bencher.dev/v0/projects/<project>/badge?branch=main)](https://bencher.dev/console/projects/<project>/alerts)

Bencher Self-Hosted

Bencher Self-Hosted では、ご自身の API サーバーの URL を使用します:

![Bencher](https://<api-host>/v0/projects/<project>/badge)

プライベートプロジェクト

プライベートプロジェクトのバッジには API キーが必要ですが、 README の画像は API キーを送信できません。 公開 README では、公開プロジェクトのバッジだけを使用してください。

更新

バッジは最大 5 分間キャッシュされることがあるため、 アラートが生成または却下されてから約 5 分以内に更新されます。