ビルドイベントを指定する (C#)

[アーティクル]
02/01/2024

ビルド開始前またはビルド終了後に実行するコマンドを指定するには、ビルドイベントを使います。

ビルドイベントを指定する

ソリューションエクスプローラーで、ビルドイベントを指定するプロジェクトを選択します。
[プロジェクト] メニューの [プロパティ] をクリックします。
[ビルドイベント] タブを選択します。
[ビルド前に実行するコマンドライン] ボックスで、ビルドイベントの構文を指定します。

Note

プロジェクトが最新の状態で、ビルドがトリガーされない場合、ビルド前イベントは実行されません。
[ビルド後に実行するコマンドライン] ボックスで、ビルドイベントの構文を指定します。

Note

.bat ファイルを実行するすべてのビルド後コマンドの前に call ステートメントを追加します。たとえば、call MyFile.bat または call MyFile.bat call MyFile2.bat です。パスは、絶対パスまたはプロジェクトフォルダーに対する相対パスにすることができます。
[ビルド後イベントの実行] ボックスで、ビルド後イベントを実行する条件を指定します。

Note

長い構文を追加する場合、または [ビルド前に実行するコマンドライン]/[ビルド後に実行するコマンドライン] ダイアログボックスでビルドマクロを選択する場合は、省略記号 [...] ボタンをクリックして編集ボックスを表示します。

ソリューションエクスプローラーで、ビルドイベントを指定するプロジェクトを選択します。
[プロジェクト] メニューで、[{ProjectName} のプロパティ] をクリックします (または、ソリューションエクスプローラーから、Alt+Enter キーを押します)。
[ビルド] > [イベント] を選択します。
[ビルド前のイベント] セクションで、ビルドイベントの構文を指定します。

注意

プロジェクトが最新の状態で、ビルドがトリガーされない場合、ビルド前イベントは実行されません。
[ビルド後のイベント] セクションで、ビルドイベントの構文を指定します。

注意

.bat ファイルを実行するすべてのビルド後コマンドの前に call ステートメントを追加します。たとえば、call MyFile.bat または call MyFile.bat call MyFile2.bat です。パスは、絶対パスまたはプロジェクトフォルダーに対する相対パスにすることができます。
[When to run the post-build event](ビルド後のイベントをいつ実行するか) セクションで、ビルド後のイベントを実行する条件を指定します。

ビルドイベントコマンドを作成する

ビルドイベントコマンドでは、コマンドプロンプトまたは .bat ファイルで有効な任意のコマンドを使うことができます。後続のすべてのコマンドが確実に実行されるように、バッチファイルの名前の前には call を記述する必要があります。バッチファイル自体は、出力フォルダー (例: bin/Debug) から実行されます。すべての構成に同じバッチファイルが必要な場合は、プロジェクトファイルと同じフォルダーに配置し、call ../../prebuild.bat などの相対パスを使用できます。

PowerShell MyPowerShellScript.ps1 などのコマンドを入力することで、PowerShell スクリプトを実行できます。 PowerShell スクリプトへのパスは絶対パスにするか、プロジェクトディレクトリに対する相対パスにすることができます。スクリプトを実行するには、オペレーティングシステム上の PowerShell スクリプトの実行ポリシーが適切に設定されていることを確認する必要があります。実行ポリシーに関するページを参照してください。

bash などの別のシェルを使用する場合は、通常、Windows コマンドプロンプトからシェルスクリプトを起動する場合と同じコマンド構文を使用します。サードパーティ製のシェルの使用についてはこのドキュメントでは取り上げませんが、Stack Overflow などのサイトが役に立つ場合があります。

プロジェクトファイルで

前の手順を実行すると、Visual Studio で、PreBuild または PostBuild ターゲットと、指定した手順を実行するために必要な MSBuild コードが追加されることで、プロジェクトファイルに変更が加えらえれます。プロジェクトファイルを開いて、その手順を確認することができます。プロジェクトファイルの手順は変更しても問題ありません。変更を保存した後は、プロジェクトのプロパティの [ビルド] > [イベント] セクションで、加えた変更を確認できます。

<Target Name="PreBuild" BeforeTargets="PreBuildEvent">
  <Exec Command="call prebuild.bat" />
</Target>

<Target Name="PostBuild" AfterTargets="PostBuildEvent">
  <Exec Command="call postbuild.bat" />
</Target>

Exec 要素は MSBuild Exec タスクを参照します。実行のカスタマイズに使用できるその他のパラメーターについては、「Exec タスク」を参照してください。たとえば、実行可能ファイルの実行元フォルダーを設定するために WorkingDirectory を使用できます。既定値は、プロジェクトファイルが含まれるディレクトリです。

<Exec Command="call prebuild.bat" WorkingDirectory="$(OutDir)">

この記事の「マクロ」で後述されているように、前の例にある OutDir のような MSBuild プロパティ (マクロ) を使用できます。

エラーとその他の出力

ビルドイベントの出力は、出力ウィンドウの [ビルド] セクションに書き込まれます。これを開くには、[表示]>[Other Window] (その他のウィンドウ)、[出力ウィンドウ] の順に選択するか、Ctrl+Alt+O キーを押します。 [出力元の表示] の横にあるドロップダウンで、[ビルド] を選択します。

ビルド前またはビルド後イベントが正常に完了しない場合は、ゼロ (0) 以外のコードでイベントアクションを終了させて、ビルドを終了することができます。ゼロ終了コードは正常なアクションを示します。その他の終了コードはエラーと見なされます。

ビルド前イベントが失敗した場合は、[エラー一覧] ウィンドウに次のようなエラーが表示されることがあります。

MSB3073    The command "call c:\source\repos\prebuild.bat" exited with code 1.

[エラー一覧] ウィンドウに十分な情報がない場合は、出力ウィンドウを使用して、バッチファイルからのすべての出力が含まれる、完全なビルド出力を確認することができます。

ヒント

[エラー一覧] ウィンドウは、イベントに入力した最初の行である 1 行の出力のみに制限されます。 [エラー一覧] ウィンドウの出力が重要な場合は、イベントに複数の行を含めることは避けてください。 Windows コマンドプロンプトまたはオペレーティングシステムからバッチファイルを作成し、そのイベントにだけ call mybatchfile.bat を使用します。コマンドをバッチファイル自体に含めます。

バッチファイルで使用できるコマンドのガイダンスについては、「Windows のコマンド」を参照してください。

マクロ

一般に使用できる "マクロ" (実際には MSBuild のプロパティ) は MSBuild 共通プロパティに関するページに記載されています。 .NET SDK プロジェクト (.NET Core または .NET 5 以降) の場合、追加のプロパティは「Microsoft.NET.Sdk の MSBuild プロパティ」に記載されています。

ビルドイベントのスクリプトでは、プロジェクトの名前や出力フォルダーの場所など、一部のプロジェクトレベルの変数の値を参照することができます。以前のバージョンの Visual Studio では、これらは マクロ と呼ばれていました。最近のバージョンの Visual Studio では、マクロに相当するものは MSBuild プロパティです。 MSBuild は、Visual Studio がビルドを実行するときにプロジェクトファイルの処理に使われるビルドエンジンです。 IDE のビルドイベントは、プロジェクトファイル内の MSBuild ターゲットになります。プロジェクトファイルのターゲットで使用可能な任意の MSBuild プロパティ (たとえば、$(OutDir) または $(Configuration)) を使うことができます。これらのイベントで使用できる MSBuild プロパティは、.props や .targets ファイルなどプロジェクトファイルに暗黙的または明示的にインポートされたファイルや、PropertyGroup 要素などプロジェクトファイルに設定されたプロパティに依存します。各プロパティのスペルが正確になるように注意してください。プロパティのスペルを間違えてもエラーにはなりません。その代わり、未定義のプロパティは空文字列として評価されます。

たとえば、ビルド前のイベントを次のように指定するとします。

ビルド前のイベントの例を示すスクリーンショット。

このビルド前のイベントは、次のようにプロジェクトファイルの Target というエントリになります。

  <Target Name="PreBuild" BeforeTargets="PreBuildEvent">
    <Exec Command="echo Configuration: $(Configuration)&#xD;&#xA;echo DevEnvDir: $(DevEnvDir)&#xD;&#xA;echo OutDir: $(OutDir)&#xD;&#xA;echo ProjectDir: $(ProjectDir)&#xD;&#xA;echo VisualStudioVersion: $(VisualStudioVersion)&#xD;&#xA;echo AssemblySearchPaths: $(AssemblySearchPaths)&#xD;&#xA;echo AssemblyName: $(AssemblyName)&#xD;&#xA;echo BaseIntermediateOutputPath: $(BaseIntermediateOutputPath)&#xD;&#xA;echo CscToolPath: $(CscToolPath)" />
  </Target>

ビルドイベントは、Command として指定した入力と共に Exec タスクを含むターゲットとして表示されます。改行は XML でエンコードされます。

この例でプロジェクトをビルドすると、ビルド前イベントでいくつかのプロパティの値が出力されます。この例では、$(CscToolPath) は定義されていないため、何も出力されません。これは省略可能なプロパティであり、C# コンパイラのカスタマイズされたインスタンスへのパスを指定するために、プロジェクトファイル内で定義できます (たとえば、異なるバージョンの csc.exe、または実験用のコンパイラをテストしている場合など)。

ビルドイベントの出力はビルド出力に書き込まれ、 [出力] ウィンドウに表示されます。 [出力元の表示] ドロップダウンで、 [ビルド] を選びます。

Build started...
1>------ Build started: Project: ConsoleApp4, Configuration: Debug Any CPU ------
1>You are using a preview version of .NET. See: https://aka.ms/dotnet-core-preview
1>Configuration: Debug
1>DevEnvDir: C:\Program Files\Microsoft Visual Studio\2022\Preview\Common7\IDE\
1>OutDir: bin\Debug\net6.0\
1>ProjectDir: C:\source\repos\ConsoleApp4\ConsoleApp4\
1>VisualStudioVersion: 17.0
1>ALToolsPath:
1>AssemblySearchPaths: {CandidateAssemblyFiles};{HintPathFromItem};{TargetFrameworkDirectory};{RawFileName}
1>AssemblyName: ConsoleApp4
1>BaseIntermediateOutputPath: obj\
1>CscToolsPath:
1>Skipping analyzers to speed up the build. You can execute 'Build' or 'Rebuild' command to run analyzers.
1>ConsoleApp4 -> C:\source\repos\ConsoleApp4\ConsoleApp4\bin\Debug\net6.0\ConsoleApp4.dll

注意

一部のシナリオでは、ビルドイベントで実行できるものよりも、より複雑なビルドアクションが必要です。たとえば、多くの一般的なコード生成シナリオでは、クリーン操作とリビルド操作を処理する必要があります。また、コード生成手順に対してインクリメンタルビルドを有効にし、入力に関して出力が古くなっている場合にのみ手順を実行するようにすることができます。 MSBuild は、これらのすべてのシナリオをインテリジェントに処理するように設計されています。 AfterTargets または BeforeTargets を指定し、ビルドプロセスの特定の時点で実行するカスタムターゲットを作成することを検討してください。また、高度なシナリオでさらに制御するために、カスタムタスクを作成することを検討するか、ビルドをカスタマイズできる別の方法を確認してください。

例

プロジェクトフォルダーに、次のような内容の postbuild.bat という名前のバッチファイルを作成します。
```
echo Copying output file %1 to %1.copy
copy %1 %1.copy
```
バッチファイルにおいて、%1 は渡された最初の引数を指すことを思い出してください。
プロジェクトプロパティの [ビルド後のイベント] セクションでそのバッチファイルを呼び出し、MSBuild プロパティ $(TargetPath) を使用して引数を渡します。
```
call postbuild.bat $(TargetPath)
```

プロジェクトをビルドし、出力フォルダーを確認します。ビルドされたアセンブリの横に、コピーしたファイルが表示されます。 出力ウィンドウの [ビルド] セクションに、バッチファイルの出力が表示されます。

1>Output file is C:\source\repos\ConsoleApp-BuildEvents\ConsoleApp-BuildEvents\bin\Debug\net6.0\ConsoleApp-BuildEvents.dll
1>        1 file(s) copied.
========== Build: 1 succeeded, 0 failed, 0 up-to-date, 0 skipped ==========
========== Build started at 12:00 PM and took 00.723 seconds ==========

ビルドイベントを指定する (C#)