ビルドステップの設定

構成とパイプラインのビルドステップ

TeamCity は、.NET、Maven、NAnt、Xcode などの特定のビルドツール用に設計された幅広いビルドステップを提供します。

現在、ビルド構成ではすべてのステップが利用可能です。バージョン 2025.07 で導入されたパイプラインは、一部のサブセットをサポートしています。ただし、スクリプトステップはエージェントマシンにインストールされている任意のツールでコマンドを実行できるため、あらゆるタイプのプロジェクトをビルドできます。

TeamCity UI でステップを追加する

ビルド構成

1. 構成設定を開き、ビルドステップ設定タブに移動します。

2. ビルドステップを追加をクリックしてビルドステップを手動で選択するか、ビルドステップの自動検出をクリックして TeamCity に VCS ルートの対象となるリモートリポジトリをスキャンさせ、適切なステップを提案させます。

新しいビルドステップページには 2 つの列が含まれます。

• デフォルトの手順 - JetBrains によって事前定義されています。

• レシピ (旧メタランナー) — TeamCity コミュニティまたはチームによって作成されたカスタム XML または YAML ステップ。

JetBrains マーケットプレイスの公開レシピへのアクセスは、プロジェクト設定によって異なります。詳しくは、レシピの操作の記事を参照してください。

パイプライン

1. ジョブ設定を開き、サイド設定パネルのステップセクションまでスクロールします。

2. 任意のタイルをクリックして、対応するビルドステップを追加します。

コードにステップを追加する

TeamCity は、Kotlin DSL および YAML (現在はパイプラインのみ) 形式の configuration-as-code をサポートします。

ステップ実行条件

ビルドステップは、UI または構成コードに表示されている順序で、上から下へと実行されます。デフォルトでは、TeamCity はいずれかのステップが失敗するまですべてのステップを実行します。いずれかのステップが失敗すると、ビルドは失敗としてマークされ、残りのステップはスキップされます。

ステップをいつ実行するかを定義するカスタム実行ポリシーを設定することで、ビルド構成でこの動作をオーバーライドできます。

実行条件は 2 つの部分で構成されます。

1. 対応するドロップダウンメニューから選択された一般的なルール。

2. 条件を追加メニューからオプションの追加条件が追加されます。

Bootstrap ステップ

ブートストラップステップは、ビルドがトリガーされた直後、ビルドエージェントがソースファイルをチェックアウトする前に実行されます。これにより、初期セットアップを実行し、後続のステップが期待どおりに実行されるようにするランナー (通常はコマンドライン (スクリプト)) を追加できます。

ブートストラップステップを有効にするには、まず teamcity.internal.bootstrap.steps.enabled=true エントリを TeamCity の内部プロパティまたは個々のプロジェクト (このプロジェクトの構成パラメーターとして) に追加します。この設定により、次の操作を実行できます。

• ステップ設定でブートストラップ中に実行するオプションを有効にします。

  

• 構成のビルドステップページで、ビルド手順を並べ替えるをクリックし、必要なステップを「準備段階」ブロックの前にドラッグします。

  

ブートストラップステップを使用してビルド構成を作成し、この構成をテンプレートに変換できます。このようなテンプレートを使用すると、実際のビルドプロセスが開始される前に、必要な前提条件アクションを実行する追加の構成をすばやく作成できます。

レシピは単一のステップとして扱われるため、チェックアウトの前後に実行される部分に分割することはできません。

Kotlin DSL で通常のステップをブートストラップステップに変換するには、teamcity.step.phase パラメーターを追加し、その値を「bootstrap」に設定します。

エージェントレスビルド手順

エージェントレスのビルド手順は、ビルドエージェントを接続せずに外部ソフトウェアで実行できるステップです。

通常、実行中のビルドは、最終ステップが TeamCity の外部で実行された場合でも、最後までビルドエージェントを占有します。ただし、ビルドが残りのいくつかのステップでエージェントを必要としない場合は、このエージェントからデタッチできます。エージェントが使用可能になり、すぐに別のビルドに割り当てることができます。

このアプローチにより、エージェントの作業時間を節約でき、サードパーティツールを使用してビルドを完成させる構成に最適です。たとえば、多数のテストを実行したり、プロジェクトをデプロイしたりする場合などです。このようなビルドは TeamCity の外で終了する可能性があります。TeamCity サーバーは、エージェントをメディエーターとして使用せずに、ステータスレポートを直接検出します。

コンパイル、テスト、デプロイの 3 つのステップで構成されるビルドの例を考えてみましょう。デプロイステップは実際には外部ソフトウェアによって実行されますが、これらはすべてエージェントによって処理されます。エージェントは、外部ソフトウェアをポーリングし、ビルドステータスを TeamCity サーバーに報告しているだけです。

エージェントレスアプローチでは、エージェントは最後のデプロイステップを処理する必要がなく、キューから他のビルドを実行できます。TeamCity サーバーは、外部ツールから直接次のレポートをキャッチします。

関連事項: エージェントからビルドを切り離す

ステップステータスパラメーター

TeamCity は、指定された ID のステップのステータスを報告する teamcity.build.step.status.<step_ID> パラメーターを提供します。これらのパラメーターは、たとえば、きめ細かな実行条件の作成に使用できます。

ステップ ID は名前に表示され、作成時にのみ編集できます。

teamcity.build.step.status.<step_ID> パラメーターの使用可能な値は次のとおりです。

• success — ステップがエラーなしで終了したとき。

• failure — ステップが失敗したとき。このステータスは、すべてのビルドの問題がミュートされている場合でも報告されます。

• cancelled — このステップの実行中にビルドがキャンセルされたとき。

teamcity.build.step.status.<step_ID> パラメーターは、対応するステップが終了した後にのみ表示され、ビルドの開始直後からは使用できません。これは、まだ実行中のステップも、スキップされたステップも、使用可能な teamcity.build.step.status.<step_ID> パラメーターがないことを意味します。

すべてのステップのステータスは、ビルド結果ページのパラメータータブで確認できます。

... または TeamCity REST API 経由。

追加情報

• 元のビルド構成設定ページから、あるビルド構成から別のビルド構成にビルドステップをコピーできます。

• 必要に応じてビルドステップを並べ替えることができます。テンプレートから継承されたビルド構成がある場合、継承されたビルドステップを並べ替えることはできないことに注意してください。ただし、カスタムビルドステップ（継承されない）は、継承されたビルドステップの前または間にある場合でも、任意の場所および順序で挿入できます。継承されたビルドステップは、元のテンプレートでのみ並べ替えることができます。

• ビルド構成テンプレートから継承されている場合でも、ビルドステップリストの最後の列にある対応するオプションを使用して、ビルドステップを一時的または永続的に無効にすることができます。