ステータス発行者のコミット

共通設定

VCS ルート

The VCS ルート that carries out all TeamCity-to-VCS communication operations. This can be a separate VCS root, or the one that your build configuration/pipeline already uses to check out repository files.

出版社

The type of your VCS. Other Commit Status Publisher settings vary depending on this setting.

サーバー URL

The URL of your VCS server. Use the default value for public services and enter a custom URL for on-premises solutions. For example, https://api.github.com for GitHub.com and http[s]://<host>[:<port>]/api/v3 for GitHub Enterprise.

Auth settings

These settings specify how Commit Status Publisher should authenticate to your VCS before it can post build statuses. You can click the 接続のテスト button at the dialog's bottom to verify your current settings are valid.

For most of the VCS providers, you have the following options:

• Password — the classic username/password credentials pair. Note that most of the providers gradually deprecate this auth mode as least secure.

• アクセストークン — authenticate using the personal access token that you should manually issue on the VCS side. For certain providers (for example, GitHub), you can click the magic wand button to let TeamCity automatically retrieve the access token using a pre-configured OAuth 接続 :

  

  Otherwise, issue with correct permissions manually. For example, for GitHub:

  • Classic GitHub tokens: public_repo and repo:status for public repositories; repo for private repositories. See also: OAuth アプリのスコープ(英語)。

  • Fine-grained tokens: Add the Commit Statuses permission with the "Read and write" access type. This permission can only be added for tokens with the "All repositories" or "Only select repositories" access type. See also: きめ細かな個人アクセストークンに必要な権限(英語)。

• リフレッシュ可能なアクセストークン — use short-lived tokens acquired by TeamCity from a required VCS provider via existing OAuth/App connections (as opposed to static PAT tokens issued manually by users on a VCS hosting side). See the following article for more information on generating and using refreshable tokens: リフレッシュ可能なアクセストークンの管理。

• VCS ルート認証情報を使用する — TeamCity は、VCS ルート設定から認証情報を抽出しようとします。このオプションは、トークン (静的 / 個人またはリフレッシュ可能 /OAuth) を使用して認証を通過し、HTTP(S) フェッチ URL を使用してリポジトリを取得する VCS ルート向けに設計されています。関連する VCS ルートが匿名または標準のユーザー名とパスワードによる認証を採用している場合、または SSH フェッチ URL を使用している場合は、他のオプションを選択してください。

Build name

The custom build name displayed in the status message. Allows you to include %parameter_name% parameter references. For example, overview section image shows statuses generated with the following custom build name:

Integration tests (build #%build.number%, %teamcity.agent.jvm.os.name%)

This setting is available for all Git-based providers: Azure DevOps, Bitbucket Cloud, Bitbucket Server and Data Center, GitHub (the "Status check name" setting), GitLab ("External job name"), and JetBrains Space ("Display name").

プロバイダー固有の構成

JetBrains Space

バージョン 2023.11 以降、事前定義された Space のつながりによってセットアップされた TeamCity ビルド構成では、ビルドステータスをポストするために構成されたコミットステータスパブリッシャーは必要ありません。

スペース接続を使用してプロジェクトをセットアップすると、TeamCity はスペースコミット数およびブランチタブの自動化セクションにビルド関連のコメントを自動的に投稿します。

Commit Status Publisher 機能を手動で設定することもできます。次の場合は手動セットアップを選択できます。

• カスタムの発行者名やスペースプロジェクトキーを設定したい場合。

• TeamCity はビルドステータスを自動的に公開できません (たとえば、カスタム構成で JetBrains Space のオンプレミスインスタンスを利用している場合にこれが発生する可能性があります)。

コミットステータスパブリッシャーを手動で設定するには、定義済みの Space のつながりが必要です。適切な接続がなく、プロジェクトが手動で作成されたか、リポジトリ URL から作成された場合は、プロジェクト設定 | 接続に移動して新しい接続を作成してください。

次に、ビルド構成の設定で:

1. 機能を構築するを開き、ステータス発行者のコミットビルド機能を追加します。

2. JetBrains Space パブリッシャーと作成された接続を選択します。

3. Space でこのサービスに表示される名前を指定します。

4. 設定を保存します。

Perforce ヘリックススウォーム

Perforce シェルフファイルの変更でビルドが実行された場合(英語)、TeamCity はそのステータスをコメントとして Perforce HelixSwarm のそれぞれのコードレビューに報告できます。

詳細については、ヘルプ記事 Perforce Helix Swarm との統合を参照してください。

Publish Pipeline Run Statuses

Commit Status Publisher is one of the most frequently used build configuration features, as it is easy to configure and provides a clear benefit of improving the overall observability. For that reason, we have natively integrated this functionality in pipelines: enable the リポジトリにステータスを公開する toggle in the repository settings and TeamCity will do the rest.

VCS チェックアウトルールでの CommitStatusPublisher の使用

ビルドの VCS ルートにチェックアウトルールが構成されている場合、Commit Status Publisher は、これらのルールに準拠するコミットのみを考慮します。つまり、ビルド開始前に行われた最後のコミットがチェックアウトルールを満たさない場合、ビルドステータスのラベルは付けられません。代わりに、最後の満足のいくコミットの横にステータスが表示されます。

ビルドの最後のコミットの横にビルドステータスを表示する必要がある場合（プルリクエストなど）、このコミットが VCS ルートのスコープに含まれるようにチェックアウトルールを調整できます。または、これが繰り返し発生する問題である場合は、ビルドチェーンを次のように再配置することを検討してください。

1. チェックアウトルールを使用してメインビルドを構成します。

2. ビルド手順とチェックアウトルールを使用せずに、ステータスパブリッシャーのコミット機能を使用してユーティリティ複合ビルドを構成します。

3. 複合ビルドで、メインビルドへのスナップショットの依存関係を構成します。

このようなチェーンの範囲では、コミットステータスパブリッシャーはチェックアウトルールに拘束されず、ビルドステータスは最後のコミットの横に表示されます。

Kotlin DSL

In Kotlin DSL , configure the jetbrains.buildServer.configs.kotlin.buildFeatures.CommitStatusPublisher object inside the features block of a buildType instance to set up your commit status publisher.

See this link for more information: CommitStatusPublisher | Kotlin DSL docs(英語).

トラブルシューティング

TeamCity は、Commit Status Publisher ビルド機能に関連するイベントを teamcity-commit-status.log ファイルに書き込みます。「debug-commit-status」プリセットを適用して、DEBUG レベルのイベントをこのログに含めます。

サンプル

以下の例は、プルリクエストに含まれる変更を含むビルドのステータスを TeamCity から GitHub に送信するように構成する方法を示しています。

1. プルリクエストビルド機能を使用して、プルリクエストブランチを構成します。または、VCS ルートでブランチ仕様を構成し、プルリクエストブランチが含まれていることを確認することで、ブランチを利用できるようにすることもできます (関連するブログ投稿(英語)も参照してください)。

2. Commit StatusPublisher ビルド機能を追加します。

   • デフォルトの接続されているすべての VCS ルートオプションを使用して、接続されているすべての VCS ルートのコミットのステータスを公開します

   • パブリッシャーとして GitHub を選択し、接続の詳細と資格情報を指定して、接続をテストします。

     

3. 設定を保存してください。

4. ソースコードへの変更をコミットし、GitHub でプルリクエストを作成してから、TeamCity で変更を加えたビルドを実行します。コミットステータスパブリッシャーは、プルリクエストの変更を加えたビルドのステータスを通知します。

   • チェックが以下であるかどうかが表示されます。

     • 進行中

     • 失敗した

     • 成功した

   • コミットステータスにカーソルを合わせると、ビルドの概要が表示されます

   • ビルドステータスアイコンまたは詳細リンクをクリックすると、TeamCity でビルド結果ページが開きます。この情報は、プルリクエストの詳細のコミット数タブでも確認できます。
     前のページと同様に、ビルドステータスアイコンをクリックすると、TeamCity UI にビルド結果ページが開きます。