.NET

.NET バージョン検出アルゴリズム

TeamCity は、次の順序で .NET 実行可能ファイルを検索します。

1. TeamCity エージェントの環境変数 DOTNET_HOME で定義されたディレクトリ内。例: DOTNET_HOME=D:\SDK\dotnet\

2. .NET 実行可能ファイルのデフォルトディレクトリ:

   • Windows: C:\Program Files\dotnet または C:\Program Files (x86)\dotnet、または他のデフォルトのプログラムファイルディレクトリ (環境変数 ProgramW6432 に応じて)

   • Unix: /usr/share/dotnet

   • Mac: /usr/local/share/dotnet

3. PATH 環境変数で指定されたパス内。

TeamCity は、検出した最初の .NET バージョンを使用します。複数の .NET バージョンがインストールされている場合は、DOTNET_HOME 変数に最新バージョンを指定することをお勧めします。

メイン設定

コマンド

次のいずれかのコマンドを選択できます。

• build

• clean

• restore
  ( プライベートフィードの認証には .NET CLI 2.1.400+ が必要です)

• pack

• publish

• run

• test

• msbuild

• vstest

• nuget delete
  ( プライベートフィードの認証には .NET CLI 2.1.500+ が必要です)

• nuget push
  ( プライベートフィードの認証には .NET CLI 2.1.500+ が必要です)

• devenv (Visual Studio リファレンスでさらに読む)

• カスタム .NET コマンド

プロジェクト

プロジェクトとソリューションへのパスを改行で区切ったリストです。* ワイルドカードをサポートしています。パラメーター参照はサポートしていません。

作業ディレクトリ

ビルドステップが開始されるディレクトリです。デフォルトでは、エージェントがリモートソースをチェックアウトするルートディレクトリと同じです。詳細については、作業ディレクトリを構築するトピックを参照してください。

フレームワーク

ターゲットフレームワーク。例: netcoreapp または netstandard パラメーター参照をサポートします。

必要な SDK

ビルドエージェントにインストールする必要がある SDK のスペース区切りのリスト。例: 8 4.8.2

これらがないエージェントは、このビルドを実行するには互換性がないとみなされます。

構成

ターゲット構成。例: Release または Debug パラメーター参照をサポートします。

ランタイム

ターゲットランタイム。パラメーター参照をサポートします。

指定されたプロジェクトファイルにランタイム ID が記載されている場合は、 ボタンをクリックしてこのランタイムをすぐに選択できます。

オプション

特定のコマンドに使用できる追加オプション。

• プロジェクトをビルドしないでください — プロジェクトを最初にビルドせずに公開またはテストできます。

• 単一セッションでテストを実行する — 複数のテストアセンブリが test または vstest コマンドのターゲットとしてリストされている場合、TeamCity は各ターゲットに対して個別のテストコマンドを呼び出すことができます。

NuGet パッケージソース

復元中に使用する NuGet パッケージソース。

出力ディレクトリ

出力を配置するディレクトリ。パラメーター参照をサポートします。

バージョン接尾辞

プロジェクト内の $(VersionSuffix) プロパティの値。パラメーター参照をサポートします。

コマンドラインパラメーター

dotnet コマンドの追加のコマンドラインパラメーター。

ログの冗長性

次のいずれかのログ詳細モードを選択できます。

• <Default>

• Minimal

• Normal

• Detailed

• Diagnostic

'msbuild' コマンドオプション

msbuild コマンドは、Microsoft ビルドエンジンを使用してプロジェクトとそのすべての依存関係をビルドするために使用されます。選択した MSBuild のバージョンに応じて、msbuild はクロスプラットフォームの .NET CLI コマンドまたは Windows のみの msbuild.exe ツールとして実行できます。

msbuild コマンドは、.NET ランナーの基本的な CLI コマンドといくつかの共通オプションを共有します (詳細については、対応するセクションを参照してください)。

サポートされている MSBuild バージョン: 4 以降 / 12 以降。

ターゲット

スペースまたはセミコロンで区切られたターゲットのリストです。ターゲットとは、プロジェクトで使用する任意のスクリプトです。フィールドの横にあるリストアイコンをクリックすると、利用可能なターゲットが表示されます。

MSBuild バージョン

インストールされている MSBuild エンジンのバージョン。特定のバージョンのネイティブ MSBuild が使用されるようにするには（たとえば Docker コンテナー内など）、PATH 環境変数に MSBuild.exe へのパスを設定する必要があります。詳細については、エージェント要件セクションを参照してください。

このフィールドにバージョンを設定し、現在のステップをコンテナー内で実行することを選択した場合は、PATH 環境変数に MSBuild.exe へのパスを指定してください。これにより、.NET ランナーは Docker コンテナー内でも必要な実行ファイルを見つけることができるようになります。

'vstest' コマンドオプション

vstest コマンドは、VSTest エンジンでプロジェクトをテストし、テスト結果を自動的にインポートするために使用されます。選択した VSTest バージョンに応じて、vstest はクロスプラットフォームの .NET CLI コマンドまたは VSTest コンソール(英語)として実行できます。

サポートされている VSTest バージョン: 2013 以降。

テストアセンブリ

テストを実行するアセンブリへのパス（ビルドチェックアウトディレクトリからの相対パス）の改改行コードリスト。ワイルドカードをサポートします。

除外されたテストアセンブリ

vstest コマンドが無視するアセンブリへのパス（ビルドチェックアウトディレクトリからの相対パス）の改改行コードリスト。ワイルドカードをサポートします。

VSTest バージョン

使用する VSTest のバージョン。詳細については、エージェント要件セクションを参照してください。

プラットフォーム

ターゲットプラットフォーム。例: x86、x64、ARM<Auto> のままにしておくと、VSTest がプラットフォームを自動的に選択します。

単独で実行

TeamCity が分離されたプロセスでテストを実行できるようにします。

テストろ過

次のテストろ過モードのいずれかを選択できます。

• テスト名 — 含まれているアセンブリで検出されたすべてのテストのうち、指定された値と一致する名前のテストのみが実行されます。値が複数ある場合は、新しい行で区切ります。フィールドが空の場合、すべてのテストが実行されます。詳細は Microsoft のドキュメントを参照してください。

• テストケースフィルター — 指定された式に一致するテストを実行します。詳細は Microsoft のドキュメントを参照してください。

関連事項: 選択した単体テストを実行する

テスト再試行回数

テストが失敗した場合、TeamCity は同じビルド実行中に、そのテストの自動再実行をシームレスに開始できます。失敗したテストは、成功するか、最大試行回数に達するまで再起動されます。この手法により、不安定なテストを識別し、起動試行回数に関係なく常に失敗する本当に問題のあるテストと区別することができます。

最初は失敗したが、その後の再実行で正常に終了したテストは自動的にミュートされます。ビルド結果ページのテストタブをチェックして、各テストに必要な再実行回数を確認できます。

設定ファイル

.runsettings ファイルへのパス。

'devenv' コマンドオプション

.NET ランナーは、 devenv コマンドで Visual Studio コマンドラインモードをサポートします。

Devenv を使用すると、IDE のカスタムオプションを構成し、さまざまなスイッチを使用してコマンドラインからプロジェクトをビルド、デバッグ、デプロイできます。

devenv は、.NET ランナーの基本的な CLI コマンドといくつかの共通オプションを共有します (詳細については、対応するセクションを参照してください)。

ビルドアクション

サポートされている値のいずれか:

• clean

• rebuild

• build

• deploy

Visual Studio バージョン

インストールされている Visual Studio のバージョン。<Any> では最新のバージョンを使用します。

詳細については、エージェント要件のセクションを参照してください。

コンテナー設定

このビルドステップは、Docker または Podman によってデプロイされたコンテナー内で実行できます。

クラシックビルド構成ステップでは、イメージ名、プラットフォーム、追加の実行引数を指定できる一連のプロパティが表示されます。明示的にイメージをプルするにより、このステップが実行されるたびに、TeamCity がターゲットコンテナーからイメージをプルすることが保証されます。

TeamCity が指定のイメージを検索するレジストリを指定するには、プロジェクトに Docker/Podman 接続を追加します。デフォルトでは、この接続により TeamCity は Docker Hub(英語) から匿名モードでイメージをプルできますが、任意のコンテナーレジストリに設定できます。

詳細については、次の記事を参照してください: コンテナーラッパー。

コンテナー内でステップを実行するには、Docker で実行をオンに切り替えます。有効にすると、この要素に 2 つのオプションが表示されます。

• Docker イメージ — Docker または Podman レジストリからイメージをプルできます。デフォルトでは、TeamCity は Docker、Hub イメージを匿名モードでプルできます。その他のケース（プライベートイメージ、カスタムイメージレジストリ、Docker、Hub のレート制限に違反しない非匿名モードなど）の場合は、パイプラインまたはジョブレベルで Docker 統合を設定してください。

• Dockerfile — Dockerfile からカスタムイメージを構築できます。

コードカバレッジ

JetBrains dotCover は、msbuild、test、vstest のカバレッジツールおよび多数のカスタムコマンドとしてサポートされています。複数の個別の .NET ランナーによって生成されたスナップショットを 1 つの統合レポートにマージするには、構成に dotCover を追加します。

非推奨のランナーから .NET ランナーへの移行

MSBuild ランナーからの移行

TeamCity 2019.2.3 以降、MSBuild エンジンを使用してプロジェクトをビルドするには、.NET ランナーが推奨される方法です。.NET プラットフォーム開発戦略の長期サポートを確保するために、リファクタリングされた .NET ランナーに msbuild コマンドを追加しました。

既存のビルド構成の MSBuild の歩数を .NET ランナーに安全に切り替えることができます。すべての追加のコマンドラインパラメーターと他の重要な設定を新しいランナーにコピーしてください。.NET ランナーで使用可能な設定の詳細については、 msbuild セクションを参照してください。

.NET ランナーで追加される機能は次のとおりです。

• .NET プロジェクト用のクロスプラットフォーム MSBuild のサポート。

• ランタイムフィールドで指定された異なるプラットフォーム用のプロジェクトをビルドする機能。

• コンテナーラッパー拡張機能を備えた Docker コンテナーでプロジェクトを実行する機能。

移行する前に、次の点を考慮してください。

• .NET ランナーは、デフォルトで x86 実行プラットフォームを使用します。x86 バージョンが利用できない場合は、x64 を使用します。

• .NET ランナーは、dotCover に対してのみコードカバレッジを提供します。

• Mono はこのランナーではサポートされていません。

MSBuild ステップで Mono または NCover/PartCover のいずれかを積極的に使用している場合は、いずれかのフィードバックチャネルからお知らせください。

Visual Studio(sln) ランナーからの移行

Visual Studio (sln) ビルドランナーは、内部で MSBuild エンジンを使用しており、VS ユーザーが TeamCity でプロジェクトをビルドする際のエクスペリエンスを容易にするためにいくつかの調整が提供されています。TeamCity 2019.2.3 以降、.NET ランナーは MSBuild エンジンでプロジェクトをビルドするための推奨方法であり、Visual Studio (sln) ステップのユーザーにとっても移行オプションとなっています。

一般に、既存の各 Visual Studio(sln) ビルドステップを .NET ランナーにソフトに切り替えるには、次のことを行う必要があります。

1. Visual Studio(sln) ランナーの設定とコマンドラインパラメーターの値を覚えているか、コピーします。

2. Visual Studio(sln) ビルドステップを .NET ランナーに切り替え、msbuild コマンドを選択します。

3. msbuild セクションに従ってフィールドに入力します。
   .NET ランナーでは、特定のフィールドの類似体が異なることに注意してください。

   • Visual Studio のバージョンとプラットフォームの代わりに、MSBuild のバージョンを指定する必要があります。バージョンに関するリファレンス(英語)を参照してください。

   • ソリューションへのパスは、プロジェクトフィールドで指定する必要があります。

msbuild への移行の詳細については、それぞれのセクションを参照してください。

Visual Studio テストランナーからの移行

TeamCity 2019.2.3 以降、.NET ランナーは、Visual Studio テストランナーの代わりに VSTest でプロジェクトをテストするための推奨方法です。.NET プラットフォーム開発戦略を長期間サポートするために、リファクタリングされた .NET ランナーに vstest コマンドを含めました。

選択した vstest コマンドを使用して、既存の Visual Studio テストのビルドステップを .NET ランナーに安全に移行できます。すべての追加のコマンドラインパラメーターと他の重要な設定を新しいランナーにコピーしてください。.NET ランナーで使用可能な設定の詳細については、 vstest セクションを参照してください。

.NET ランナーで追加される機能は次のとおりです。

• .NET プロジェクト用のクロスプラットフォーム VSTest のサポート。

• デフォルトでは、リアルタイムのテストレポート。

• x86 および x64 に加えて、ARM プラットフォームのサポート。

• コンテナーラッパー拡張機能を備えた Docker コンテナー内でプロジェクトを実行およびテストする機能。

移行する前に、次の点を考慮してください。

• .NET ランナーは、VSTest 設定ファイルの新しい .runsettings 形式をサポートしています。ただし、Visual Studio テストランナーで使用されている古い実行構成ファイル形式はサポートしていません。

• フレームワークバージョンの代わりに、.NET ランナーは VSTest バージョンを指定するように要求します。

• .NET ランナーは、dotCover に対してのみコードカバレッジを提供します。MSBuild ステップで NCover または PartCover を積極的に使用している場合は、いずれかのフィードバックチャネルからお知らせください。

• .NET ランナーは、そのフレームワークのすべての機能が VSTest でカバーされているため、MSTest ツールをサポートしていません。Visual Studio テストランナーのエンジンとして MSTest を使用していた場合は、.NET ランナーに移行するときに VSTest に切り替えることをお勧めします。

スペースを含むパラメーターを渡す方法

スペース文字を含むパラメーター値を渡す最適な方法は、システムプロパティを使用することです。例: ビルド設定 |Parameters に Any CPU 値を含む system.Platform パラメーターを追加し、.NET ステップ内でこの値を %system.Platform% として参照できます。

別の方法は、コマンドラインパラメーターを "/p:Platform=Any CPU" のようにラップすることです。