READMEにCIの速度バッジを追加する
最終更新
CI スピードバッジは、リポジトリの直近の GitHub Actions 実行の中央値時間を README 上に表示します。コントリビューターは、チェックの完了までどのくらい待つのかをひと目で把握できます。数値が小さいことは、プロジェクトが適切に管理されていることを静かに示すシグナルにもなります。このページでは、バッジの追加方法、数値の意味、そしてその背後にあるプライバシーのルールを説明します。
バッジ
compiler.dev で CI を実行しているリポジトリの場合、OWNER/REPO を置き換えたうえで、次の行を README.md に追加してください:
[](https://compiler.dev/benchmarks)
CI | 2m 14s · compiler.dev のような小さなバッジとして表示されます。GitHub は README の画像を camo プロキシを通じてキャッシュします。このバッジは 10 分間のキャッシュを許可しているため、数値は実行結果にほぼ追従します。
数値の意味
表示される時間は、過去 30 日間の直近 20 件のワークフロー実行の中央値です。最初のジョブがキューに入ってから最後のジョブが終了するまでを計測します。つまり、ジョブの実行時間の合計ではなく、キュー待ち時間を含めて、コントリビューターが実際に待つ時間です。すべてのジョブが compiler.dev のマシン上で完了した実行だけが対象になります。そのため、自前のランナーにフォールバックした実行によって数値が歪むことはありません。
平均ではなく中央値を使うのは、one 件のスタックやキャンセルされた実行によってバッジの数値が大きく跳ね上がるのを防ぐためです。
プライバシー
バッジに時間が表示されるのは 公開 リポジトリだけです。数値を表示する前に、compiler.dev は GitHub の公開 API を確認します。プライベートリポジトリ、または GitHub が認識しないリポジトリの場合、バッジには単に「powered by compiler.dev」と表示されます。そのため、プライベートリポジトリのバッジ URL を公開の場所に置いても、そのリポジトリについては、compiler.dev を使っているかどうかさえ明らかになりません。
まだ compiler.dev を使っていない場合
バッジには実行時間が必要ですが、これは compiler.dev が実行したジョブについて記録されるものです。今すぐ CI を計測したい場合は、無料の CI Timing Report アクションを使ってください。すべての実行のサマリーに、ジョブごとの計測表が追加されます。数値を小さくするには、まず GitHub Actions を高速化する方法 と テストシャード計算ツール をご覧ください。
よくある質問
なぜバッジに時間ではなく「powered by compiler.dev」と表示されるのですか?
リポジトリがプライベートであるか、直近 30 日間に compiler.dev で完了した実行がないか、または GitHub の API に接続できなかったことが考えられます。URL 内のオーナー名とリポジトリ名が GitHub 上の表記と完全に一致しているか確認してください。
バッジはどのくらいの頻度で更新されますか?
実行時間は最大で 10 分ごとに再計算されます。また、バッジは GitHub によって 10 分間キャッシュされることが許可されているため、新しい実行は約 20 分以内に反映されます。
特定のワークフローだけにバッジを使うことはできますか?
現時点ではできません。バッジは、compiler.dev で実行されたリポジトリのすべてのワークフロー実行を対象とします。ワークフローごとの数値が必要な場合は、CI Timing Report アクションが各実行のサマリーに表示します。
関連記事
- GitHub ActionsでTypeScriptモノレポを高速化するGitHub Actionsで TypeScriptモノレポの型チェックとリンターを高速化する: インクリメンタルtsc、プロジェクト参照、Lintキャッシュ、並列ジョブ
- GitHub ActionsでモノレポのPlaywrightを高速化するGitHub Actions で Node モノレポの Playwright E2E テストを高速化: アプリを一度だけビルドし、Web アプリに変更がないときは E2E をスキップし、シャーディングとレポートのマージを行います。
- GitHub Actionsで.NETを高速化するGitHub Actions で .NET のビルドを高速化する: setup-dotnet による NuGet キャッシュ、--no-restore、--no-build、並列の dotnet test、SQL Server サービス。
- GitHub ActionsでBazelを高速化するGitHub Actions で Bazel を高速化する: setup-bazel、ディスクキャッシュ、リポジトリキャッシュ、リモートキャッシュ、適切な --jobs 設定。動作する YAML 付き。