Skip to content

fsprojects/FAKE

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Files

Permalink
Failed to load latest commit information.

FAKE - F# Make · FAKE Build and Test NuGet Badge PRs Welcome Join the chat at https://gitter.im/fsharp/FAKE

"FAKE - F# Make" is a cross platform build automation system. Due to its integration in F#, all the benefits of the .NET Framework and functional programming can be used, including the extensive class library, powerful debuggers and integrated development environments like Visual Studio or MonoDevelop, which provide syntax highlighting and code completion.

The new DSL was designed to be succinct, typed, declarative, extensible and easy to use.

Here is an example to get a glimpse on FAKE:

// build.fsx

#r "paket:
nuget Fake.Core.Trace
nuget Fake.Core.Target //"
// include Fake modules, see Fake modules section

open Fake.Core

// *** Define Targets ***
Target.create "Clean" (fun _ ->
  Trace.log " --- Cleaning stuff --- "
)

Target.create "Build" (fun _ ->
  Trace.log " --- Building the app --- "
)

Target.create "Deploy" (fun _ ->
  Trace.log " --- Deploying app --- "
)

open Fake.Core.TargetOperators

// *** Define Dependencies ***
"Clean"
  ==> "Build"
  ==> "Deploy"

// *** Start Build ***
Target.runOrDefault "Deploy"

This example pulls Fake's Target and Trace modules and define three targets: Clean, Build, and Deploy. By analogy with a .Net project;

  • the Clean target can be used to clean the project before a build,
  • the Build target to call MSBuild or any build steps that are required for you application,
  • the Deploy target can push your built project to a cloud service.

At the bottom, the example define target dependencies, which specify that a Deploy must run after a Build which must run after a Clean.

See the project home page for tutorials and the API documentation for various FAKE modules.

Requirements

Fake runner requires .Net v6 SDK to be installed on the machine to run it. .Net v6 was chosen since it is the current LTS release of .Net

FAKE 5 doesn't have this requirement. You can use FAKE 5 runner without having .NET 6 SDK installed since it will default to NETSTANDARD2.0 assemblies. But we advice to see the options available to run your build script in Different Ways to run FAKE

Fake modules has target frameworks of net6 and netstandard2.0. Please see this link which lists the supported .Net and .NET Framework versions by netstandard2.0

Installation

  • Either: Download and install the Dotnet SDK and run dotnet tool restore followed by dotnet fake build
  • Or: Install FAKE 5 or later (for example via choco install fake -pre) and run fake build

Note: You can find more details on the contributing page

Make sure to have long path enabled: see how to enable long paths Otherwise the test-suite will fail (However, the compilation should work)

Usage

See detailed instructions on how to use FAKE in the getting started guide.

NuGet Packages

Package Name Nuget
Fake-Cli NuGet Badge
Fake.Core.Target NuGet Badge
Fake.Core.Context NuGet Badge
Legacy FAKE NuGet Badge

Contributing

See the contributing page.

Maintainers

Although this project is hosted in the fsprojects organization, it is not maintained and managed by the F# Core Engineering Group. The F# Core Engineering Group acknowledges that the independent owner and maintainer of this project is Steffen Forkmann.