TeamCity オンプレミス 2025.11 ヘルプ

カスタムビルドの実行

通常、ビルド構成ではビルドトリガーを使用して、必要なスケジュールに従って、または TeamCity がソースコード内の新しい変更を検出したときに新しいビルドを開始します。

これらの自動的にトリガーされるビルドに加えて、TeamCity ではビルドを手動で実行し、必要に応じて設定をカスタマイズすることもできます。つまり、新しいプロパティの追加または既存のプロパティの変更、特定の変更の選択、ビルドのスケジュール、ビルドを実行するエージェントの選択などを行うことができます。

TeamCity には、カスタムビルドを実行するための複数のオプションが用意されています。

  • 実行ボタンの横にある省略記号ボタンをクリックし、カスタムビルドを実行するダイアログでオプションの設定を指定します (詳細については、このセクションを参照してください)。

  • 特定の変更を加えてカスタムビルドを実行するには、ビルド結果ページを開いて、変更タブに切り替えます。必要な変更を展開し、「この変更でビルドを実行する」ボタンをクリックして、必要なオプションを指定します。

  • HTTP または REST API リクエストを TeamCity サーバーに送信します。

  • ビルドを促進します

  • カスタムパラメーターを使用してビルドを起動するようにビルドトリガーを設定します。

一般オプション

一般タブには、最も基本的で頻繁に使用される設定が表示されます。

Run custom build dialog, General Settings tab

エージェント

この設定により、ビルドを実行するエージェントを選択できます。次のオプションが利用可能です。

  • 〈 fastest idle agent 〉 (デフォルトオプション) — 選択すると、TeamCity はビルドを実行するエージェントを自動的に選択します。

  • リストから特定の TeamCity エージェントを選択します。TeamCity は、指定されたエージェントの現在の状態を表示し、(すでにビルドを実行している場合は) いつアイドル状態になるかを推定します。

  • 〈 fastest idle agent in the N pool 〉 — TeamCity は、指定されたプールからエージェント上でビルドを実行します。

  • クラウド統合が構成されている場合は、特定のクラウドイメージから生成されたエージェントでビルドを実行できます。このタイプのクラウドエージェントが利用できない場合は、TeamCity は新しいエージェントを起動しようとします。

  • <すべての有効な互換性のあるエージェント> — 有効化され、ビルド構成と互換性のあるすべてのエージェントでビルドを同時に実行します。このオプションは次の目的で使用します。

    • エージェントのメンテナンスを目的としてビルドを実行します (たとえば、環境のアップグレード / 更新後にエージェントが正しく機能するかどうかを確認する構成を作成できます)。

    • さまざまなプラットフォームでビルドを実行します (たとえば、構成をセットアップし、インストールされているさまざまな環境と互換性のあるビルドエージェントの数を指定できます)。

日付 & 時刻

ビルド実行をクリックした直後に新しいビルドを通常のキューに配置するには、できるだけ早くオプションをそのままにしておきます。

特定の日時にビルドをスケジュールするには、特定の日時にオプションに切り替えます。スケジュールされたビルドは、スケジュールされた日時までビルドキューの最後に残ります。

Scheduled build and time

ビルドオプション

  • 個人ビルドとして実行個人ビルドを実行できます。

  • ビルドをキューの先頭に配置する - この新しいビルドを現在のビルドキューの先頭に配置します。新しく開始したビルドにはすぐに使用できる互換性のあるエージェントがない場合があるため、エージェントを待機しながらキューの下位に移動できます。その場合は、ビルド構成ページで一番上に移動アイコンをクリックするか、ビルド結果ページページに移動してアクション | 一番上に移動をクリックします。

    Move queued build to top
  • ビルド前にチェックアウトディレクトリ内のすべてのファイルを削除します - TeamCity がビルドチェックアウトディレクトリをクリアするかどうかを指定します。

    • スナップショットの依存関係が構成されている場合、このオプションはスナップショットの依存関係に適用できます。この場合、ビルドチェーンのすべてのビルドはクリーンチェックアウトを使用します。

Perforce 固有の設定

現在のビルド構成で Perforce VCS ルートを使用している場合は、シェルフされたファイル(英語)に対してカスタムビルドを実行することもできます。

  1. 個人ビルドとして実行するオプションにチェックを入れます。

  2. シェルブされたファイルを含む変更リストの ID を入力します。

  3. ターゲットの Perforce ルートを選択します。

依存関係

このタブは他のビルドに依存しているビルドにのみ利用可能です

依存関係タブでは、すべての依存関係を再構築し、この新しいビルドが使用するアーティファクトの特定のビルドを選択できます。デフォルトでは、TeamCity は最新の 20 ビルドを表示します。利用可能な最近のビルドの数を増やすには、teamcity.runCustomBuild.buildsLimit=<your value> 内部プロパティを追加します。

依存関係のビルドを再実行すると、TeamCity は、以前に失敗したものも含め、すべての依存関係のビルドを再構築しようとします。

リスト内の依存関係ビルドは、最初はアルファベット順にソートされたブランチによってグループ化されます。同じブランチのビルドはビルド日によって並べ替えられます。ブランチベースの並べ替えを破棄し、すべての依存関係ビルドを日付のみで並べ替えるには、依存関係を日付で並べ替えるをクリックします。これにより、最新のビルドを最初に表示できます。デフォルトの並べ替えを復元するには、すべてリセットをクリックします。

変更

このタブは、TeamCity ユーザーがビルド構成の VCS ルートにアクセスする権限を持っている場合にのみ使用できます。

変更タブでは、ビルドに含める変更を選択できます。TeamCity は、変更のリビジョンを使用してソースをチェックアウトし、選択されたものまでのすべての変更をこの新しいビルドに含めます。

対応する VCS ルートがビルド構成から切り離されている場合、TeamCity は最新のコミットを取得できず、限られた数の変更のみを表示することに注意してください。古い変更を使用してビルドを実行するには、変更ログで必要なコミットを見つけて、この変更でビルドを実行するアクションを使用します。

含める変更

含める変更ドロップダウンメニューを使用すると、設定に関連付けられた VCS ルートのどの変更をこの新しいビルドに含めるかを選択できます。

  • ビルド開始時の最新の変更 : TeamCity には、現時点で利用可能なすべての最新の変更が自動的に含まれます。

  • 含める最後の変更 : それ以降のコミットをすべて無視するには、必要な変更を選択します。TeamCity は、履歴ビルド時に最新の変更を無視するビルドをマークします。

ブランチをビルドする

このビルド構成 (またはそのスナップショット依存関係構成) にブランチがある場合、ブランチをビルドするドロップダウンメニューを使用できます。カスタムビルドにブランチを選択できます。

設定を使用する

プロジェクトがその設定を VCS に保存している場合、このタブでは、この新しいビルドに使用する設定を選択できます。

  • TeamCity サーバーで現在定義されている設定

  • このビルド用に計算された VCS リビジョンからロードされた設定。

デフォルトの動作は、現在選択されているプロジェクト設定 | バージョン対応設定ページ設定によって異なります (詳細については、このセクションを参照してください: ビルドに適用する設定の定義 )。

特定の変更リビジョンを選択した場合、TeamCity はプロジェクト設定の対応するリビジョンもロードします。

パラメーター

このタブでは、パラメーター / プロパティ / 変数を追加、編集、削除したり、事前定義されたパラメーターの初期値をオーバーライドしたりできます。

次の制限が適用されます。

  • 事前定義されたプロパティと変数では、名前を編集できません (値のみ編集可能です)。

  • 削除できるのは、新しく追加されたプロパティと変数のみです。事前定義されたプロパティは削除できません。

  • パラメーター値は 16,000 文字を超えてはなりません。

コメントとタグ

このタブでは、カスタムビルドにオプションのコメントとタグを追加できます。このセクションの対応するオプションをチェックして、カスタムビルドをお気に入りに追加することもできます。

造りを促進する

プロモートされたビルドは、上書きされたアーティファクトまたはスナップショットの依存関係を持つカスタムビルドです。このようなビルドでは、デフォルトで使用されるビルドとは異なる依存関係ビルドが使用されます。

例: ビルド構成 A は、ビルド構成 B からアーティファクトを取得します。通常、新しい A ビルドを実行すると、最後に成功した B ビルドが使用されます。A で古い B ビルドを使用する場合は、この以前の B ビルドを昇格する必要があります。

ビルドをプロモートするには、依存関係ビルドのビルド結果ページを開き、アクション | プロモートをクリックします。プロモーションの効果は 1 回限りです。現在の実行後、ビルド構成はデフォルトの依存関係ロジック (最後に成功したビルドまたは最後に固定されたビルド) に戻ります。

詳細については、次のブログ投稿(英語)を参照してください。

2025 年 8 月 05 日

関連ページ:

ビルドトリガーの設定

ビルド構成が作成されると、実行ボタンをクリックしてビルドを手動でトリガーしたり、トリガーを使用して自動的に開始したりできます。ビルドトリガーは、特定のイベントで新しいビルドを開始するルールです。ビルドはビルドキューに入れられ、実行可能なエージェントが存在する場合に開始されます。ビルド構成の作成 / 編集中に、ビルド設定ページのトリガーセクションを使用してトリガーを構成できます。新しいトリガーを追加をクリックしてトリガー設定を指定します。各トリガーの構成の詳細については、対応するセクションを参照し...

ビルド結果ページ

TeamCity では、ビルドに関するすべての情報 (キューに入っているか、実行中か、完了しているかに関係なく) がビルド結果ページに蓄積されます。ビルド結果を表示するには、任意の構成を選択してビルド履歴を表示し、必要なビルド番号をクリックします。このページには、いくつかの静的タブ (概要、変更、ビルドログ、アーティファクトなど) と、特定の構成機能に応じて表示が決まるコンテキストタブが含まれます。例: 依存関係タブは、親構成がビルドチェーンに属するビルドに対してのみ表示されます。内部ビルド ID...

ビルドの開始とキャンセル

この記事では、TeamCity RESTAPI を介したビルドの開始とキャンセルに関する一般的なユースケースについて説明します。外部ソフトウェアから TeamCity ビルドを開始します。コマンドラインビルドランナーから RESTAPI を呼び出して、複雑なビルドロジックを実装します。通常のビルドを開始する:ビルドを開始できるようにするには、次のエンドポイントを介してビルドキューにアクセスする必要があります。/app/rest/buildQueue 新しいビルドをキューに入れるには、次の 2 つ...

クラウドのホストビルドエージェント

TeamCity とクラウド (IaaS) ソリューションの統合により、TeamCity は TeamCity エージェントをオンデマンドで実行する仮想マシンを提供できるようになります。これにより、TeamCity は現在のワークロードに応じてアクティブなビルドエージェントの数を自動的に調整できます。クラウドエージェントとエグゼキューター:TeamCity は次の 2 種類の統合をサポートしています。通常のクラウドエージェント。この統合タイプでは、ビルドエージェントをホストする環境として、クラ...

ビルドキューの操作

TeamCity では、ビルドキューはトリガーされた、または手動で起動され、開始を待機しているビルドのリストです。TeamCity は、ビルドがアイドル状態になるとすぐに、互換性のあるビルドエージェントに配布します。キューに入れられたビルドは、エージェントで開始された瞬間にエージェントに割り当てられます。ビルドがビルドキューで待機している間は、事前割り当ては行われません。キューページ:上部のナビゲーションバーからキューページにアクセスします。このページには、実行を待機しているビルドのリストが表...

パーソナルビルドの実行

個人ビルドは、通常、バージョン管理にまだコミットされていない変更を使用する共通ビルドシーケンスからのビルドです。個人ビルドは通常、サポートされている IDE の 1 つからリモート実行プロシージャを介して開始されます。カスタムビルドを実行するダイアログから個人ビルドを開始し、変更を加えたパッチをサーバーに直接アップロードすることもできます。個人ビルドには対応するアイコンが付いており、ビルドを開始したユーザーのみに表示されます。他の TeamCity ユーザーの個人ビルドを表示するには、ユーザープロ...