ビルドチェーン

ビルド構成設定の依存関係ページ

ビルド構成がビルドチェーンの一部である場合、対応する情報がビルド設定 | 依存関係 | スナップショット依存関係に表示されます。ビルドチェーンリンクをクリックすると、ビルドチェーンのプレビューとその構成が別のウィンドウで開きます。プレビューにはチェーンのビルドが表示されます。自動トリガーが構成されたビルドには、アイコン が付けられます。

プロジェクトホームページとビルド構成ホームページのチェーンのビルドタブ

プロジェクトとビルド構成の両方のページでビルドチェーンを確認できます。これらの各ページには、スナップショット依存関係が構成されているときに表示されるビルドチェーンタブがあります。

このタブには、このプロジェクトのビルドまたはこのビルド構成を含むチェーンのリストが表示され、フィルタリングすることができます。最後に完成したビルドのチェーンがリストの一番上に表示されるように、ビルドチェーンがソートされていることに注意してください。

円グラフのアイコンは、チェーンの一部であるビルドのステータスの比率を表示します。円グラフにカーソルを合わせると、詳細が表示されます。

チェーンが拡張されると、以下の情報も利用可能です。

• このビルドチェーンを構成するすべてのビルド

• これらのビルドの状況: トリガーされていない、キュー内、実行中または終了済み、その詳細

• チェーンは、実際の実行順にビルドを表示します。つまり、最初に開始するビルドが左側に表示されます。

チェーンでビルドをクリックすると、選択したビルドとそのすべての直接の依存関係がハイライトされます。このページ:

• チェーンのコンパクトな表現を提供します。複数のトップビルドが依存ビルドの同じチェーンをトリガーした場合、TeamCity は複数のトップビルドを含む 1 つのビルドチェーンを表示します。

• 追加の表示オプションがあります: プロジェクトによるグループ化と詳細を隠す。

• ビルドチェーンでビルドが選択されたときに、すべてのダウンストリーム / アップストリームビルドを推移的にハイライトします。

このページから、次のこともできます。

• 「トリガーされていない」ビルドがまだある場合は、チェーンを続行します。実行をクリックすると、チェーンリビジョンで新しいビルドが開始され、このチェーンからのビルドに関連付けられます。

• をクリックすると、ビルドチェーンリビジョンが事前に選択されたカスタムビルドダイアログが開きます。このアクションは、チェーンで一部のビルドを再実行する場合に使用できます。

ビルド結果ページの依存関係タブ

依存関係が設定されている場合は、ビルド結果ページの依存関係タブでその詳細を表示できます。このタブには間接的な依存関係も表示されます。たとえば、ビルド A がビルド B に依存し、ビルド B がビルド C と D に依存している場合、これらのビルド C と D はビルド A の間接的な依存関係になります。
このタブには、チェーンのビルドによってダウンロードおよび配信されたアーティファクトも表示されます。また、ビルドをグループ化 / グループ解除したり、以前のチェーンから再利用されたビルド ( 適切なビルド ) をハイライトしたりすることもできます。

カスタムビルドを実行するダイアログ

チェーン部分を実行する必要がほとんどない場合は、チェーン構成をそのままにして、チェーンの一部を実行する必要があるときはいつでもカスタムビルドを実行するダイアログを使用できます。ダイアログの依存関係タブに切り替えて、無視するビルド構成の「スキップ」オプションを選択します。

ダイアログでは、実行しようとしている構成に直接リンクされているビルド構成のみをスキップできることに注意してください。例: 「ビルド 1 →ビルド 2 →ビルド 3 →ビルド 4」の「ビルド 4」を開始すると、チェーンでは「ビルド 3」のみをスキップできます。「ビルド 4」をトリガーして、TeamCity に「ビルド 3」より前の構成を無視するように指示することはできません。

条件付きビルド依存関係

バージョン 2024.12 以降、TeamCity は teamcity.build.chain.skipTags および teamcity.build.chain.onlyTags 構成パラメーターをサポートします。これらのパラメーターを使用すると、条件付きビルド依存関係を構成できます。

• teamcity.build.chain.skipTags パラメーターは、不要な構成を明示的にスキップします。チェーンは除外されていないビルドのみを実行します。

• teamcity.build.chain.onlyTags パラメーターは、実行する構成を指定します。ただし、これによってビルドチェーンが指定された構成のみに制限されるわけではありません。

  • onlyTags が独自の依存関係を持つ構成を参照する場合、これらの依存関係も実行されます。

  • onlyTags パラメーターに記載されている構成間の構成はスキップできません。

例 1: タグをスキップ

次のチェーンには、複数のビルドおよびテスト構成が含まれており、「すべてビルド」複合構成によってチェーン全体がトリガーされます。

チェーン全体を実行すると、時間とリソースが消費される可能性があります。「すべてビルド」でコアの「ビルド ...」構成のみを実行できるようにするには、タグまたは ID のいずれかを値として使用して teamcity.build.chain.skipTags パラメーターを追加します。どちらの方法も同じですが、ニーズに最も適したものを選択してください。

skipTags パラメーター値

スキップする各構成に teamcity.configuration.tags パラメーターを追加します。これらのパラメーターを任意の文字列に設定し、teamcity.build.chain.skipTags パラメーターと同じ文字列を使用します。

以下の Kotlin スニペットでは、不要な構成に「オプション」タグを使用しています。

object TestWin : BuildType({ id("TestWin") params { param("teamcity.configuration.tags", "optional") } }) object TestAndroid : BuildType({ id("TestAndroid") params { param("teamcity.configuration.tags", "optional") } }) // ... // Other optional build configurations // ... object TeamcityGatedPrDemo_BuildAll : BuildType({ id("BuildAll") type = BuildTypeSettings.Type.COMPOSITE params { param("teamcity.build.chain.skipTags", "optional") } dependencies { snapshot(BuildLinux_iOS) {} snapshot(BuildPlugins) {} snapshot(BuildPortable) {} snapshot(BuildWin) {} } })

不要な構成をそれぞれタグでマークする代わりに、この構成 ID を teamcity.build.chain.skipTags パラメーター値として使用できます。

object TestWin : BuildType({ id("TestWin") }) object TestAndroid : BuildType({ id("TestAndroid") }) // ... // Other build configurations // ... object TeamcityGatedPrDemo_BuildAll : BuildType({ id("BuildAll") type = BuildTypeSettings.Type.COMPOSITE params { param("teamcity.build.chain.skipTags", "TestAndroid,TestIOS,TestLinux,TestPS,TestWin,BuildPlugins") } dependencies { snapshot(BuildLinux_iOS) {} snapshot(BuildPlugins) {} snapshot(BuildPortable) {} snapshot(BuildWin) {} } })

チェーン全体を実行するには、teamcity.build.chain.skipTags パラメーターを削除するか、構成タグまたは ID と一致しない任意の値に設定します。例: 短縮された毎日のビルド中に構成を省略して、完全な夜間ビルドを実行するスケジュールトリガーを追加します。TeamCity トリガー設定には、ビルドパラメーターを追加または変更できるビルドのカスタマイズセクションが含まれています。

object TeamcityGatedPrDemo_BuildAll : BuildType({ id("BuildAll") type = BuildTypeSettings.Type.COMPOSITE params { param("teamcity.build.chain.skipTags", "optional") } triggers { schedule { // Full "Build All" chain running daily at 3 AM schedulingPolicy = daily { hour = 3 } triggerBuild = always() withPendingChangesOnly = false buildParams { param("teamcity.build.chain.skipTags", "nightly-build-mode") } } } })

例 2: タグのみ

この例では、例 1 と同じチェーンを使用します。

個々の構成は、teamcity.configuration.tags パラメーターを使用してタグ付けされます。便宜上、このチェーンの Kotlin 構成はタブに分類されています。

object TestWin : BuildType({ id = AbsoluteId("TestWin") params { param("teamcity.configuration.tags", "tests,windows") } }) object BuildWin : BuildType({ id = AbsoluteId("BuildWin") params { param("teamcity.configuration.tags", "build,windows") } dependencies { snapshot(TestWin) {} } })

object TestLinux : BuildType({ id = AbsoluteId("TestLinux") params { param("teamcity.configuration.tags", "tests,linux") } }) // Shared configuration for Linux and iOS object BuildLinux_iOS : BuildType({ id = AbsoluteId("BuildLinux_iOS") params { param("teamcity.configuration.tags", "build,linux,ios") } dependencies { snapshot(TestIOS) {} snapshot(TestLinux) {} } })

object TestIOS : BuildType({ id = AbsoluteId("TestIOS") params { param("teamcity.configuration.tags", "tests,ios") } }) // Shared configuration for Linux and iOS object BuildLinux_iOS : BuildType({ id = AbsoluteId("BuildLinux_iOS") params { param("teamcity.configuration.tags", "build,linux,ios") } dependencies { snapshot(TestIOS) {} snapshot(TestLinux) {} } })

object TestAndroid : BuildType({ id = AbsoluteId("TestAndroid") params { param("teamcity.configuration.tags", "tests,portable") } }) object TestPS : BuildType({ id = AbsoluteId("TestPS") params { param("teamcity.configuration.tags", "tests,portable" } }) object BuildPortable : BuildType({ id = AbsoluteId("BuildPortable") params { param("teamcity.configuration.tags", "build,portable") } dependencies { snapshot(TestAndroid) {} snapshot(TestPS) {} } })

object BuildPlugins : BuildType({ id = AbsoluteId("BuildPlugins") params { param("teamcity.configuration.tags", "build,plugins") } })

object TeamcityGatedPrDemo_BuildAll : BuildType({ id("BuildAll") type = BuildTypeSettings.Type.COMPOSITE params { select("teamcity.build.chain.onlyTags","", label = "Choose a sub-chain to run",description = """ * run all — runs the entire chain * desktop — runs "Build (Win)" and "Build (Linux/iOS)" builds with their related tests * portable — runs the "Build (Portable)" build with its related Android/PS tests * windows — runs the "Test (Win) > Build (Win)" sequence * linux — runs the "Test (Linux) > Build (Linux/iOS)" sequence * ios — runs the "Test (iOS) > Build (Linux/iOS)" sequence * plugins — runs the solo "Build Plugins" configuration """.trimIndent(), display = ParameterDisplay.PROMPT, options = listOf( "run all" to "", "plugins", "desktop" to "windows,linux,ios", "portable" to "BuildPortable", "windows", "linux", "ios")) } dependencies { snapshot(BuildLinux_iOS) {} snapshot(BuildPlugins) {} snapshot(BuildPortable) {} snapshot(BuildWin) {} } })

複合「すべてビルド」構成では、teamcity.build.chain.onlyTags パラメーターが「プロンプト」動作モードの「選択」パラメーターとしてスタイル設定されます。チェーンが手動でトリガーされるたびに、カスタムビルドを実行するダイアログがポップアップ表示され、ユーザーは起動するチェーンの部分を選択できます。

• すべて実行 — 空の文字列にマップされたラベル。これは、onlyTags パラメーターの初期値 / デフォルト値です。このチェーンの 9 つの構成すべてを実行します。

• plugins — 「Build Plugins」構成をトリガーします。この構成は、「plugins」タグを持つ他の構成がなく、他のビルドに依存していないため、単独で実行されます。

• desktop — 「windows」、「linux」、「ios」タグのいずれかを持つ 5 つのビルド / テスト構成のサブチェーンを実行します。

• portable — ID によって「BuildPortable」構成を明示的に指定します。この構成は「TestAndroid」と「TestPS」に依存するため、3 つの構成すべてが実行されます。パラメーター値として「portable」タグを使用する場合と同じです。

• windows/linux/ios — 同一のタグにマップされたパラメーター値。プラットフォーム固有の短い「テスト→ ビルド」サブチェーンをトリガーします。共有の「BuildLinux_iOS」構成をトリガーすると、リンクされた「TestLinux」と「TestIOS」の両方の構成が強制的に実行されるため、「linux」と「ios」のサブチェーンは同一であることに注意してください。

使用可能な値のリストには、次のオプションはありません。

• build — この値はすべての「ビルド ...」構成を直接トリガーし、リンクされた「テスト ...」構成を開始します。その結果、チェーン全体が実行されます。

• tests — この値は、左端の「テスト ...」と右端の「すべてビルド」構成のみをトリガーできず、「ビルド ...」構成はそのまま残ってしまうため、ユーザーを混乱させる可能性があります。これは、TeamCity がチェーンの途中で構成をスキップできないために発生します。その場合、実行されない構成を横断する依存関係をどのように処理するかが不明になります。

サービスメッセージ

上流ビルド構成の任意のビルドステップから ##teamcity[skipQueuedBuilds tags='value1,value2,...' comment='Your comment'] サービスメッセージを送信して、下流構成のキューに入れられたビルドをキャンセルします。skipTags/onlyTags パラメーターと同様に、このメッセージの tags 引数は次のものを受け入れます。

• 構成に追加された teamcity.configuration.tags パラメーターの値。

• 構成 ID。

サービスメッセージを使用して、ビルドチェーンの特定の「部分」をキャンセルします。例: 個々のテストスイートをキャンセルするには、「ビルド」構成から skipQueuedBuilds を送信する必要があります。一部のテストが実行され、一部のテストがスキップされても、「ビルド→ テスト→ デプロイ」チェーンの整合性はそのまま維持されます。

これらのテストをすべてスキップすると、このチェーンの中間セクション全体が失われます。これにより、混乱を招く可能性のある「ビルド→ ??? →デプロイ」チェーンが生成されます。これを回避するには、構成を複製し、代わりに別の「ビルド→ デプロイ」チェーンを作成することを検討してください。