FAKE Bootstrapper for .NET Core

Description

This is a set of simple bootstrapper scripts for .NET Core projects. Build system is based on FAKE, a DSL for build tasks.

This bootstrapper can be used as is with no modifications, or use this as a starting point to create your own build system.

One of the benefits of using this build system is that it can run all the tests across all test projects in the solution in one go, something that .NET Core CLI cannot do at the moment.

Prerequisites

Solution is expected to have following structure:

src\
    SolutionName.sln
    Project1\
        Project1.csproj
        Project1.cs
    Project1.Tests\
        Project1.Tests.csproj
        Project1Tests.cs
    Project2\
        Project2.fsproj
        Project2.fs
    Project2.Tests\
        Project2.Tests.fproj
        Project2Tests.fs

source code is in the src directory
project directory name matches project file name
test projects have Tests suffix
test projects are implemeted using xUnit or other framework that provides .NET Core - compatible runner (i.e. runnable via dotnet test)
test projects can use either C# or F#

.NET Core needs to be installed so that dotnet command is available.

If you are on Linux, you can install PowerShell Core: https://docs.microsoft.com/en-us/powershell/scripting/setup/installing-powershell-core-on-linux and use exactly the same build scripts on both Linux and Windows.

Installation

Copy build directory to the root of your solution, so that it at the same level with src:

\build\
    build.fsx
    build.ps1
    build.sh
\src\
    Solution.sln
    ...

If you are planning on using Linux bash scripts, make them executable:

chmod u+x ./build/*.sh

If you are planning on using only PowerShell scripts, bash scripts (*.sh) can be removed.

Usage

Platform-specific scripts

Windows

In PowerShell propmt:

build\build.ps1 [-Target Target] \
                [-Configuration Configuration] \
                [-Runtime Runtime]

Linux

In shell propmt:

build/build.sh [-t|--target Target] \
               [-c|--configuration Configuration] \
               [-r|--runtime Runtime]

Alternatively, if you have PowerShell Core installed, run same command as for Windows in PowerShell prompt (via pwsh).

Build parameters

Target: name of the build target
- Clean: run dotnet clean
- Restore: run dotnet restore
- Build: run dotnet build
- Tests: run dotnet test for all *.Tests projects
- FullBuild (default): Build + Tests
- Purge: special target (implemented as separate script) to perform full cleanup: remove bin and obj build output directories, Fake CLI and lockfiles
Configuration: Release(default)|Debug
Runtime: linux-x64(default)|win-x64

iblazhko/fake-bootstrap