There are two recommended options to build BenchmarkDotNet from source:
Visual Studio 2017 version 15.5 Preview 4 or higher (Community, Professional, Enterprise).
Visual Studio 2017 should have installed the .NET Core SDK, but in case it did not you can get it from the Installing the .Net Core SDK page.
Visual Studio 2017 should have installed “F# language support” feature. You can also install the support directly as a separate download.
Once all the necessary tools are in place, building is trivial. Simply open solution file BenchmarkDotNet.sln that lives at the base of the repository and run Build action.
Cake (C# Make) is a cross platform build automation system with a C# DSL to do things like compiling code, copy files/folders, running unit tests, compress files and build NuGet packages.
The build currently depends on the following prerequisites:
- PowerShell version 5 or higher
- MSBuild version 15.1 or higher
- .NET Framework 4.6 or higher
After you have installed these pre-requisites, you can build the BenchmarkDotNet by invoking the build script (
build.ps1 on Windows, or
build.sh on Linux and macOS) at the base of the BenchmarkDotNet repository. By default the build process also run all the tests. There are quite a few tests, taking a significant amount of time that is not necessary if you just want to experiment with changes. You can skip the tests phase by adding the
skiptests argument to the build script, e.g.
.\build.ps1 --SkipTests=True or
Build has a number of options that you use. Some of the more important options are
skiptests - do not run the tests. This can shorten build times quite a bit. On Windows:
./build.sh --skiptests=trueon Linux/macOS.
configuration - build the 'Release' or 'Debug' build type. Default value is 'Release'. On Windows:
.\build.ps1 -Configuration Debugor
./build.sh --configuration debugon Linux/macOS.
target - with this parameter you can run a specific target from build pipeline. Default value is 'Default' target. On Windows:
.\build.ps1 -Target Defaultor
./build.sh --target defaulton Linux/macOS. Available targets:
- Default - run all actions one by one.
- Clean - clean all
- Restore - automatically execute
Cleanaction and after that restore all NuGet dependencies.
- Build - automatically execute
Restoreaction, then run MSBuild for the solution file.
- FastTests - automatically execute
Buildaction, then run all tests from the BenchmarkDotNet.Tests project.
- SlowTests - automatically execute
Buildaction, then run all tests from the BenchmarkDotNet.IntegrationTests project.
- Pack - automatically execute
Buildaction and after that creates local NuGet packages.