ツイートシェアはてブ LINE Pocket

プルリクエスト

プルリクエスト ビルド機能を使用すると、プルリクエスト * 情報を自動的にロードし、GitHub、Bitbucket サーバー、Bitbucket クラウド、GitLab、Azure DevOps、JetBrains Space のプルリクエストブランチでビルドを実行できます。

* または、GitLab と JetBrains Space の場合はリクエストをマージします。

このビルド機能を追加するときは、VCS ルートを指定し、VCS ホスティングタイプを選択する必要があります。
その他の設定は、選択した VCS ホスティングタイプによって異なります。

この機能は、現在のビルド構成に添付されている VCS ルートの元のブランチ仕様を拡張して、指定されたフィルタリング基準に一致するプル要求を含めます。

ビルド結果の概要タブに表示されているプルリクエストの詳細を確認できます。

ビルド構成に VCS トリガーを構成すると、TeamCity は監視対象のブランチで検出された変更に基づいてビルドを自動的に実行します。例: GitHub リポジトリのプルリクエストの構築を自動的に開始するには、+:pull/* ブランチフィルタールールを使用して新しいトリガーを追加します (または既存のトリガーを変更します)。

GitHub プルリクエストでビルドを実行するように TeamCity を設定する方法の例を参照するか、ビデオチュートリアル(英語)を参照してください。

VCS 固有の設定

GitHub プルリクエスト

この機能は、GitHub(英語) および GitHub Enterprise(英語) をサポートします。refs/pull/*/head ブランチでのみビルドを監視します。

GitHub ホスティング型では、次のパラメーターを使用できます。

パラメーター	オプション	説明
認証タイプ	VCS ルート認証情報を使用する	TeamCity は、VCS ルートが HTTP(S) フェッチ URL を使用する場合、VCS ルート設定からユーザー名 / パスワード認証情報または個人アクセストークン /`x-oauth-basic` を抽出しようとします。 VCS ルートが匿名認証または SSH を採用している場合、このオプションは機能しません。 GitHub Enterprise リポジトリの場合、個人アクセストークン /`x-oauth-basic` ペアのみが機能します。
	アクセストークン	個人用アクセストークンを使用するか、OAuth 接続を介してトークンを取得します。`public_repo` （パブリックリポジトリ用）または `repo` （プライベートリポジトリ用）スコープのいずれかが必要です。
作成者によるこのフィルターは、公開リポジトリにのみ適用されます。	同じ組織のメンバー	GitHub の同じ組織のメンバー(英語)によって送信されたプルリクエストのみを検出します。
	メンバーと外部の協力者	同じ組織のメンバーと GitHub の外部の共同エディター(英語)によって送信されたプルリクエストのみを検出します。
	みんな	すべてのプル要求を検出します。このオプションを選択すると、任意のユーザーがビルドエージェントで悪意のあるコードを実行できる可能性があることに注意してください。
ソース別ブランチ		ブランチフィルターを定義して、指定された基準に一致するソースブランチのプルリクエストのみを監視します。空のままにすると、フィルターは適用されません。
ターゲットブランチ		ブランチフィルターを定義して、指定された基準に一致するターゲットブランチでのみプルリクエストを監視します。空のままにすると、フィルターは適用されません。
下書きを無視		デフォルトでは、プルリクエストビルド機能は GitHub ドラフトプルリクエスト(英語)情報を読み込み、ドラフトプルリクエストでビルドを実行します。ビルドページには、プルリクエスト番号の横に「ドラフト」ステータスとアイコンが表示されます。チェックボックスをオンにして、GitHub ドラフトプルリクエストを無視します。TeamCity は、ステータスが変更されるまでドラフトプルリクエスト情報をロードしません。
サーバー URL		接続用の GitHub URL を指定します。空のままにすると、URL は VCS ルートフェッチ URL から抽出されます。

Bitbucket サーバープルリクエスト

Bitbucket サーバー(英語)ホスティング型では、次のパラメーターを使用できます。

パラメーター	オプション	説明
認証タイプ	VCS ルート認証情報を使用する	TeamCity は、VCS ルートが HTTP(S) フェッチ URL を使用する場合、VCS ルート設定からユーザー名 / パスワード認証情報を抽出しようとします。 VCS ルートが匿名認証を採用している場合、このオプションは機能しません。
	ユーザー名パスワード	Bitbucket サーバーに接続するためのユーザー名とパスワードを指定します。パスワードの代わりにアクセストークンを送信できます。トークンには、プロジェクトとリポジトリの読み取り権限が必要です。
ソース別ブランチ		ブランチフィルターを定義して、指定された基準に一致するソースブランチのプルリクエストのみを監視します。空のままにすると、フィルターは適用されません。
ターゲットブランチ		ブランチフィルターを定義して、指定された基準に一致するターゲットブランチでのみプルリクエストを監視します。空のままにすると、フィルターは適用されません。
サーバー URL		接続用の Bitbucket URL を指定します。空のままにすると、URL は VCS ルートフェッチ URL から抽出されます。
プルリクエストブランチを使用		このオプションは下位互換性のみを目的としています。ソースブランチの代わりに、正式にサポートされていない Bitbucket(英語) プルリクエストブランチ (pull-requests/*) の検出を有効にします。注意: 切り替え後、過去 1 時間以内にコミットされた変更に対して、新しいビルドがトリガーされる場合があります。

Bitbucket クラウドプルリクエスト

Bitbucket Cloud はプルリクエスト用の専用ブランチを作成しないため、このビルド機能はソースリポジトリ内のソースブランチを直接監視します (フォークはサポートされていません)。
ビルド開始時に同じソースブランチから複数のプルリクエストが送信された場合、TeamCity はこれらすべてのリクエストをビルド結果に表示します。ただし、フィルタリング基準に一致する開いている PR からのコミットのみがビルドの変更として表示されます。

VCS ルートのブランチ仕様には、プル要求ブランチに一致するパターンが含まれていてはならないことに注意してください。

Bitbucket クラウド(英語)ホスティング型では、次のパラメーターを使用できます。

パラメーター	オプション	説明
認証タイプ	VCS ルート認証情報を使用する	TeamCity は、VCS ルートが HTTP(S) フェッチ URL を使用する場合、VCS ルート設定からユーザー名 / パスワード認証情報を抽出しようとします。このオプションは、VCS ルートが SSH フェッチ URL を使用するか、匿名認証を使用する場合は機能しません。
	ユーザー名パスワード	Bitbucket クラウドに接続するためのユーザー名とパスワードを指定します。プルリクエストでアプリのパスワード(英語)を使用することをお勧めします \| スコープを読み取ります。
ターゲットブランチ		ブランチフィルターを定義して、指定された基準に一致するブランチのプルリクエストのみを監視します。空のままにすると、フィルターは適用されません。

パラメーター

オプション

説明

認証タイプ

VCS ルート認証情報を使用する

TeamCity は、VCS ルートが HTTP(S) フェッチ URL を使用する場合、VCS ルート設定からユーザー名 / パスワード認証情報を抽出しようとします。

このオプションは、VCS ルートが SSH フェッチ URL を使用するか、匿名認証を使用する場合は機能しません。

ユーザー名パスワード

Bitbucket クラウドに接続するためのユーザー名とパスワードを指定します。プルリクエストでアプリのパスワード(英語)を使用することをお勧めします | スコープを読み取ります。

ターゲットブランチ

ブランチフィルターを定義して、指定された基準に一致するブランチのプルリクエストのみを監視します。空のままにすると、フィルターは適用されません。

GitLab マージリクエスト

TeamCity は、他のホスティングサービスでプルリクエストを処理する方法と同様に、GitLab マージリクエスト(英語)を処理します。現在、TeamCity は、このビルド機能を有効にした後に送信されたマージ要求のみを検出します。

この機能は、refs/merge-requests/*/head ブランチでのみビルドを監視します。

GitLab(英語) ホスティング型では、次のパラメーターを使用できます。

パラメーター	説明
アクセストークン	接続に個人用アクセストークンを使用します。トークンには `api` スコープが必要です。
ソース別ブランチ	ブランチフィルターを定義して、指定された基準に一致するソースブランチでのみマージ要求をモニターします。空のままにすると、フィルターは適用されません。
ターゲットブランチ	ブランチフィルターを定義して、指定された基準に一致するターゲットブランチでのみマージ要求をモニターします。空のままにすると、フィルターは適用されません。
サーバー URL	接続用の GitLab URL を指定します。空のままにすると、URL は VCS ルートフェッチ URL から抽出されます。

Azure DevOps プルリクエスト

この機能は、refs/pull/*/merge ブランチでのみビルドを監視します。

Azure DevOps(英語) の場合、TeamCity は、他の VCS のようにプル要求自体ではなく、マージブランチで要求を検出します。各ビルドは仮想ブランチで起動され、PR をマージした後のビルドの実際の結果を示します。ビルドには、変更を伴うコミットと仮想マージコミットの両方が含まれます。

この機能は Azure DevOps ドラフトプルリクエストを無視することに注意してください。

次のパラメーターは、Azure DevOps ホスティング型で使用できます。

パラメーター	説明
アクセストークン	接続にはパーソナルアクセストークンを使用してください。トークンには `Code (read)` スコープが必要です。
ソース別ブランチ	ブランチフィルターを定義して、指定された基準に一致するソースブランチのプルリクエストのみを監視します。空のままにすると、フィルターは適用されません。
ターゲットブランチ	ブランチフィルターを定義して、指定された基準に一致するターゲットブランチでのみプルリクエストを監視します。空のままにすると、フィルターは適用されません。
プロジェクト URL	リモート Azure DevOps サーバーと同期するプロジェクト URL を指定します。このフィールドは、オンプレミスの AzureDevOps インストールに推奨されます。空のままにすると、URL は VCS ルートフェッチ URL に基づいて作成されます。

JetBrains Space マージリクエスト

この機能は、オリジンリポジトリのソースブランチでマージリクエストを直接監視します。
同じソースブランチから複数のマージリクエストが送信された場合、TeamCity はこれらすべてのリクエストをビルド結果に表示します。ただし、フィルタリング基準に一致するオープンリクエストからのコミットのみがビルドの変更として表示されます。

JetBrains Space ホスティング型では、次のパラメーターを使用できます。

パラメーター	説明
接続	JetBrains Space への事前構成された接続を選択します。
ターゲットブランチ	ブランチフィルターを定義して、指定された基準に一致するブランチでのみマージ要求をモニターします。空のままにすると、フィルターは適用されません。

複数の並列ビルドを実行して、リクエストをマージする前に事前テストする場合、最善の解決策は次のとおりです。

複合ビルド構成を作成し、空のブランチ仕様を持つ JetBrains Space VCS ルートをそれに接続します。
テストを使用した並列ビルドでスナップショットの依存関係を構成することにより、ビルドチェーンの最後に複合ビルド構成を追加します。
チェーンの各ビルド構成にプルリクエスト機能を追加して、すべてのビルドがマージリクエストブランチの変更を検出できるようにします。ビルド構成テンプレートですべての設定を事前構成してから、それに基づいてこれらのビルド構成を作成できます。
複合ビルド構成設定の場合:
- VCS トリガーを追加して、マージ要求ブランチで検出された変更に基づいてビルドを自動的に実行します。
- ステータス発行者のコミット機能を追加して、ビルドステータスを JetBrains Space のコミット詳細に送信します。
  チェーンの他のビルド (たとえば、デプロイまたは統合テストビルド) がステータスを JetBrains Space に報告するようにするには、対応するビルド構成に Commit Status Publisher 機能を追加します。

その後、TeamCity は、JetBrains Space リポジトリに送信されたマージリクエストブランチの変更に基づいてビルドを自動的に実行し、Space のマージリクエストタイムラインにビルドステータスを公開します。

JetBrains Space ブランチを未検証のマージリクエストから保護するために、リポジトリ設定で品質ゲートを構成することもできます。TeamCity ビルドを外部チェックとして設定した場合、JetBrains Space では、このリクエストのマージを許可する前に、マージリクエストのビルドが正常に終了する必要があります。

JetBrains Space マージリクエストの処理に関する既知の問題については、こちらを参照してください。