VSBuild@1 - Visual Studio ビルド v1 タスク
このタスクを使用して MSBuild を使用してビルドし、Visual Studio バージョン プロパティを設定します。 Azure に Visual Studio イメージをインストールする方法の詳細については、こちらを参照してください。
構文
# Visual Studio build v1
# Build with MSBuild and set the Visual Studio version property.
- task: VSBuild@1
inputs:
solution: '**\*.sln' # string. Required. Solution. Default: **\*.sln.
#vsVersion: 'latest' # 'latest' | '17.0' | '16.0' | '15.0' | '14.0' | '12.0' | '11.0'. Visual Studio Version. Default: latest.
#msbuildArgs: # string. MSBuild Arguments.
#platform: # string. Platform.
#configuration: # string. Configuration.
#clean: false # boolean. Clean. Default: false.
# Advanced
#maximumCpuCount: false # boolean. Build in Parallel. Default: false.
#restoreNugetPackages: false # boolean. Restore NuGet Packages. Default: false.
#msbuildArchitecture: 'x86' # 'x86' | 'x64'. MSBuild Architecture. Default: x86.
#logProjectEvents: true # boolean. Record Project Details. Default: true.
#createLogFile: false # boolean. Create Log File. Default: false.
#logFileVerbosity: 'normal' # 'quiet' | 'minimal' | 'normal' | 'detailed' | 'diagnostic'. Optional. Use when createLogFile = true. Log File Verbosity. Default: normal.
#enableDefaultLogger: true # boolean. Enable Default Logger. Default: true.
#customVersion: # string. Custom Version.
# Visual Studio build v1
# Build with MSBuild and set the Visual Studio version property.
- task: VSBuild@1
inputs:
solution: '**\*.sln' # string. Required. Solution. Default: **\*.sln.
#vsVersion: 'latest' # 'latest' | '16.0' | '15.0' | '14.0' | '12.0' | '11.0'. Visual Studio Version. Default: latest.
#msbuildArgs: # string. MSBuild Arguments.
#platform: # string. Platform.
#configuration: # string. Configuration.
#clean: false # boolean. Clean. Default: false.
# Advanced
#maximumCpuCount: false # boolean. Build in Parallel. Default: false.
#restoreNugetPackages: false # boolean. Restore NuGet Packages. Default: false.
#msbuildArchitecture: 'x86' # 'x86' | 'x64'. MSBuild Architecture. Default: x86.
#logProjectEvents: true # boolean. Record Project Details. Default: true.
#createLogFile: false # boolean. Create Log File. Default: false.
#logFileVerbosity: 'normal' # 'quiet' | 'minimal' | 'normal' | 'detailed' | 'diagnostic'. Optional. Use when createLogFile = true. Log File Verbosity. Default: normal.
# Visual Studio Build v1
# Build with MSBuild and set the Visual Studio version property.
- task: VSBuild@1
inputs:
solution: '**\*.sln' # string. Required. Solution. Default: **\*.sln.
#vsVersion: 'latest' # 'latest' | '16.0' | '15.0' | '14.0' | '12.0' | '11.0'. Visual Studio Version. Default: latest.
#msbuildArgs: # string. MSBuild Arguments.
#platform: # string. Platform.
#configuration: # string. Configuration.
#clean: false # boolean. Clean. Default: false.
# Advanced
#maximumCpuCount: false # boolean. Build in Parallel. Default: false.
#restoreNugetPackages: false # boolean. Restore NuGet Packages. Default: false.
#msbuildArchitecture: 'x86' # 'x86' | 'x64'. MSBuild Architecture. Default: x86.
#logProjectEvents: true # boolean. Record Project Details. Default: true.
#createLogFile: false # boolean. Create Log File. Default: false.
入力
solution
- ソリューション
string
. 必須です。 既定値: **\*.sln
。
ビルド プロセスで使用するタスクのソリューションを指定します。
1 つのソリューションをビルドする場合は、[ ... ] ボタンをクリックし、ソリューションを指定します。
複数のソリューションを作成する場合は、検索条件を指定します。 単一フォルダーのワイルドカード (*
) と再帰的なワイルドカード (**
) を使用できます。 たとえば、 **.sln
すべてのサブディレクトリ内のすべての.slnファイルを検索します。
指定したソリューションがこのビルド パイプラインによってダウンロードされていることを確認します。 [リポジトリ] タブで、以下を行います。
- TFVC を使用する場合は、ソリューションが [リポジトリ] タブのいずれかのマッピングの子であることを確認します。
- Git を使用する場合は、プロジェクトまたはソリューションが Git リポジトリ内にあり、ビルド中のブランチにあることを確認します。
ヒント
- MSBuild プロジェクト (.*proj) ファイルをビルドすることもできます。
- カスタマイズした MSBuild プロジェクト ファイルをビルドする場合は、Visual Studio ビルド タスクではなく MSBuild タスクを使用することをお勧めします。
vsVersion
- Visual Studio のバージョン
string
. 使用できる値: latest
、(Visual Studio 2022)、 16.0
(Visual Studio 2019) 15.0
、(Visual Studio 2017) 14.0
、(Visual Studio 2015) 12.0
、(Visual Studio 2013) 11.0
、(Visual Studio 2012 17.0
)。 既定値: latest
。
この入力の値は、ソリューションの作成に使用される Visual Studio のバージョンと一致している必要があります。
/p:VisualStudioVersion={numeric_visual_studio_version}
ビルドによって実行される MSBuild コマンドに引数を追加します。 たとえば、 Visual Studio 2015 を指定した場合、 /p:VisualStudioVersion=14.0
は MSBuild コマンドに追加されます。
Azure Pipelines: チームが Microsoft でホストされているエージェントで Visual Studio を使用する場合は、既定のビルド プールとして [windows-latest ] を選択します。 「Microsoft によってホストされるエージェント」を参照してください。
vsVersion
- Visual Studio のバージョン
string
. 使用できる値: latest
、(Visual Studio 2019)、 15.0
(Visual Studio 2017) 14.0
、(Visual Studio 2015) 12.0
、(Visual Studio 2013) 11.0
、(Visual Studio 2012 16.0
)。 既定値: latest
。
この入力の値は、ソリューションの作成に使用される Visual Studio のバージョンと一致している必要があります。
/p:VisualStudioVersion={numeric_visual_studio_version}
ビルドによって実行される MSBuild コマンドに引数を追加します。 たとえば、 Visual Studio 2015 を指定した場合、 /p:VisualStudioVersion=14.0
は MSBuild コマンドに追加されます。
Azure Pipelines: チームが Microsoft でホストされているエージェントで Visual Studio を使用する場合は、既定のビルド プールとして [windows-latest ] を選択します。 「Microsoft によってホストされるエージェント」を参照してください。
msbuildArgs
- MSBuild 引数
string
.
MSBuild に追加の引数を渡します。 構文については、「 MSBuild Command-Line リファレンス」を参照してください。
platform
- プラットフォーム
string
.
、 などWin32
x86
x64
、ビルドするプラットフォームを指定します。any cpu
ヒント
- ソリューションではなく MSBuild プロジェクト (.*proj) ファイルをターゲットにする場合は、
AnyCPU
(空白なし) を指定します。 - [変数] タブで
BuildPlatform
などのビルド変数を宣言し ([キュー時間で許可] を選択)、ここで$(BuildPlatform)
として参照します。 これにより、ビルドをキュー登録し、複数の構成のビルドを有効にするときにプラットフォームを変更できます。
configuration
- 構成
string
.
や など debug
、ビルドする構成を指定します release
。
ヒント
[変数] タブで BuildConfiguration
などのビルド変数を宣言し ([キュー時間で許可] を選択)、ここで $(BuildConfiguration)
として参照します。 これにより、ビルドをキュー登録し、複数の構成のビルドを有効にするときにプラットフォームを変更できます。
clean
- きれい
boolean
. 既定値: false
。
に設定すると false
、タスクは増分ビルドを行います。 この設定により、特にコードベースが大きい場合、ビルド時間が短縮される可能性があります。 このオプションは、Clean リポジトリも に設定しない限り、実用的な false
効果はありません。
に true
設定すると、タスクはコード プロジェクト内のすべてのコードを再構築します。 これは MSBuild /target:clean
引数と同じです。
maximumCpuCount
- 並列ビルド
boolean
. 既定値: false
。
省略可能。 MSBuild ターゲット構成が並列ビルドと互換性がある場合は、この入力をチェックして、スイッチを /m
MSBuild に渡すことができます (Windows のみ)。 ターゲット構成が並列ビルドと互換性がない場合、このオプションにチェックを付けると、ビルドでファイル使用中エラーや、断続的または一貫性のないビルド エラーが発生する可能性があります。
restoreNugetPackages
- NuGet パッケージを復元する
boolean
. 既定値: false
。
この入力は非推奨です。 NuGet パッケージを復元するには、ビルドの前に NuGet ツール インストーラー タスクを追加します。
msbuildArchitecture
- MSBuild アーキテクチャ
string
. 使用できる値: x86
(MSBuild x86)、 x64
(MSBuild x64)。 既定値: x86
。
省略可能。 実行する MSBuild のアーキテクチャ (x86
または x64
) を提供します。
ヒント
Visual Studio は 32 ビット アプリケーションとして実行されるため、64 ビット バージョンの Team Foundation Build Service を実行しているビルド エージェントによってビルドが処理されると、問題が発生する可能性があります。 MSBuild x86
を選択すると、これらの問題を解決できます。
logProjectEvents
- プロジェクトの詳細を記録する
boolean
. 既定値: true
。
省略可能。 各プロジェクトタイムライン詳細を記録します。
createLogFile
- ログ ファイルの作成
boolean
. 既定値: false
。
省略可能。 ログ ファイルを作成します (Windows のみ)。
logFileVerbosity
- ログ ファイルの詳細
string
. 省略可能。 の場合は createLogFile = true
を使用します。 使用できる値: quiet
、、minimal
、normal
、detailed
diagnostic
。 既定値: normal
。
ログ ファイルの詳細レベルを指定します。
enableDefaultLogger
- 既定のロガーを有効にする
boolean
. 既定値: true
。
に設定すると true
、MSBuild の既定のロガーが有効になります。
customVersion
- カスタム バージョン
string
.
Visual Studio のカスタム バージョンを設定します。 例: 15.0
、、16.0
17.0
。 必要なバージョンの Visual Studio をシステムにインストールする必要があります。
Azure Pipelines: チームが Microsoft でホストされているエージェントで Visual Studio 2022 を使用する場合は、既定のビルド プールとして を選択 windows-2022
します。 詳細については、「 Microsoft でホストされるエージェント」を参照してください。
タスク制御オプション
すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。
出力変数
[なし] :
解説
Azure への Visual Studio イメージのインストールの詳細については、こちらを参照してください。
重要
このタスクは、Windows を実行しているエージェントでのみサポートされます。