FAKE - F# Make

Contains tasks to interact with GitHub releases

Sample

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 
11: 
12: 
13: 
14: 
15: 

   Target.create "GitHubRelease" (fun _ ->
       let token =
           match Environment.environVarOrDefault "github_token" "" with
           | s when not (System.String.IsNullOrWhiteSpace s) -> s
           | _ -> failwith "please set the github_token environment variable to a github personal access token with repro access."

       let files =
           runtimes @ [ "portable"; "packages" ]
           |> List.map (fun n -> sprintf "release/dotnetcore/Fake.netcore/fake-dotnetcore-%s.zip" n)

       GitHub.createClientWithToken token
       |> GitHub.draftNewRelease gitOwner gitName release.NugetVersion (release.SemVer.PreRelease <> None) release.Notes
       |> GitHub.uploadFiles files
       |> GitHub.publishDraft
       |> Async.RunSynchronously)

Contains tasks to interact with HockeyApp

Contains a task to send notification messages to a Slack webhook

Contains tasks to package Azure Cloud Services.

Note: This documentation is for FAKE version 5.0 or later. The old documentation can be found here

Contains tasks to control the local Azure Emulator

Contains tasks to stage and deploy Azure website and webjobs using source code deployment with Kudu Sync.

Contains tasks to package and deploy Azure Web Jobs via the Kudu Zip controller

Note: This documentation is for FAKE version 5.0 or later. The old documentation can be found here

Contains tasks which allow to use CMake to build CMakeLists files. See Samples/CMakeSupport for usage examples.

native support for AppVeyor specific APIs. The general documentation on how to use CI server integration can be found here. This module does not provide any special APIs please use FAKE APIs and they should integrate into this CI server. If some integration is not working as expected or you have features you would like to use directly please open an issue.

native support for GitHub Actions specific APIs. The general documentation on how to use CI server integration can be found here. This module does not provide any special APIs please use FAKE APIs and they should integrate into this CI server. If some integration is not working as expected or you have features you would like to use directly please open an issue.

native support for GitLab specific APIs. The general documentation on how to use CI server integration can be found here. This module does not provide any special APIs please use FAKE APIs and they should integrate into this CI server. If some integration is not working as expected or you have features you would like to use directly please open an issue.

native support for TeamCity specific APIs. The general documentation on how to use CI server integration can be found here. This module does not provide any special APIs please use FAKE APIs and they should integrate into this CI server. If some integration is not working as expected or you have features you would like to use directly please open an issue.

For more information on TeamCity interaction from build scripts see here

native support for Azure DevOps (previously VSTS) / Team Foundation Server specific APIs. The general documentation on how to use CI server integration can be found here

Secret Variables

This CI server supports the concept of secret variables and uses the Vault to store them. In order to access secret variables you need to use one of the fake 5 tasks from vsts-fsharp.

Example implementation (supports runner and vault tasks)

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 
11: 
12: 
13: 
14: 
15: 
16: 
17: 
18: 
19: 
20: 

   // Either use a local vault filled by the 'FAKE_VAULT_VARIABLES' environment variable
   // or fall back to the build process if none is given
   let vault =
       match Vault.fromFakeEnvironmentOrNone() with
       | Some v -> v // fake 5 vault task, uses 'FAKE_VAULT_VARIABLES' by default
       | None -> TeamFoundation.variables // fake 5 runner task

   // Only needed if you want to fallback to 'normal' environment variables (locally for example)
   let getVarOrDefault name =
       match vault.TryGet name with
       | Some v -> v
       | None -> Environment.environVarOrFail name
   Target.create "Deploy" (fun _ ->
       let token = getVarOrDefault "github_token"
       // Use token to deploy to github

       let apiKey = getVarOrDefault "nugetkey"
       // Use apiKey to deploy to nuget
       ()
   )

native support for Travis specific APIs. The general documentation on how to use CI server integration can be found here. This module does not provide any special APIs please use FAKE APIs and they should integrate into this CI server. If some integration is not working as expected or you have features you would like to use directly please open an issue.

This module tracks the context of the build. This allows us to run some modules without any context and change behavior depending on the context (For example Fake.Process kills all processes when the Fake Context exists, but it should not when used as library)

This module contains helpers for managing build time variables

Helper functions for proper command line parsing

Module for working with an Arguments instance

Module for creating and modifying CreateProcess<'TRes> instances. You can manage:

• The command (ie file to execute and arguments)
• The working directory
• The process environment
• Stream redirection and pipes
• Timeout for the process to exit
• The result and the result transformations (map, mapResult)

More extensions can be found in the CreateProcess Extensions

Example

1: 
2: 
3: 
4: 

Command.RawCommand("file", Arguments.OfArgs ["arg1"; "arg2"])
|> CreateProcess.fromCommand
|> Proc.run
|> ignore

Some extensions for the CreateProcess module, opened automatically (use add open Fake.Core)

Module to start or run processes, used in combination with the CreateProcess API.

Example

1: 
2: 
3: 
4: 
5: 
6: 

#r "paket: 
nuget Fake.Core.Process //"
open Fake.Core
CreateProcess.fromRawCommand "./folder/mytool.exe" ["arg1"; "arg2"]
|> Proc.run
|> ignore

Contains basic functions for string manipulation.

This module contains function which allow to trace build output

Contains functions to read and write XML files.

Provices a encrypted store of variables to prevent accidential leakage Please read the documentation

Contains helpers which allow to parse Change log text files. These files have to be in a format as described on http://keepachangelog.com/en/1.1.0/

Contains helpers which allow to parse Release Notes text files. Either "simple" or "complex" format is accepted.

Parser which allows to deal with Semantic Versioning (SemVer). Make sure to read the documentation in the SemVerInfo record as well if you manually create versions.

Contains active patterns which allow to deal with Semantic Versioning (SemVer).

Provides functions and operators to deal with FAKE targets and target dependencies.

Contains a helper which can be used to implement timeouts and retries.

Helpers for capturing user input

Some extensions for the CreateProcess module, opened automatically (use add open Fake.Core)

Contains helper functions to use DocFx https://dotnet.github.io/docfx/.

Analyse a binlog and emit proper CI messages

Contains tasks to compiles F# source file with the FSharp.Compiler.Service.

Note: This documentation is for FAKE version 5.0 or later. The old documentation can be found here

Contains tasks which allow to run FSharp.Formatting for generating documentation.

Contains a task to invoke the FxCop tool

Sample

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 
11: 
12: 

   Target.create "FxCop" (fun _ ->
       Directory.ensure "./_Reports"
       let rules = [ "-Microsoft.Design#CA1011"   // maybe sometimes
                     "-Microsoft.Design#CA1062" ] // null checks,  In F#!
       !! ("**/bin/Debug/*.dll")
       |> FxCop.run { FxCop.Params.Create() with WorkingDirectory = "."
                                                 UseGAC = true
                                                 Verbose = false
                                                 ReportFileName = "_Reports/FxCopReport.xml"
                                                 Rules = rules
                                                 FailOnError = FxCop.ErrorLevel.Warning
                                                 IgnoreGeneratedCode = true})

Contains task a task which allows to merge .NET assemblies with ILMerge.

Sample

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 
11: 
12: 

   Target.create "ILMerge" (fun _ ->
        let target = !!"./bin/Release/*.exe" |> Seq.head
        let out = "./bin" @@ (Path.GetFileName target)
        ILMerge.run
          { ILMerge.Params.Create() with DebugInfo = true
                                         TargetKind = ILMerge.TargetKind.Exe
                                         Internalize = ILMerge.InternalizeTypes.Internalize
                                         Libraries =
                                            Seq.concat
                                              [ !!"./bin/Release/Mono.C*.dll"
                                                !!"./bin/Release/Newton*.dll" ]
                                         AttributeFile = target } out target)

Contains helper functions which allow FAKE to call the Manifest Generation and Editing Tool, in short 'MAGE'. The intentional use is the creation of a clickonce application.

Contains helper functions and task which allow to inspect, create and publish NuGet packages with Paket.

Contains helper functions and task which allow it to generate a paket.template file for Paket

Contains tasks for building Xamarin.iOS and Xamarin.Android apps

Contains functions used to transform config (or any XML) files using Microsoft's XML Document Transformations.

Contains tasks for installing NuGet packages using the nuget.exe install command.

Contains helper functions and task which allow to inspect, create and publish NuGet packages. There is also a tutorial about nuget package creating available.

Contains tasks which allow to restore NuGet packages from a NuGet package feed like nuget.org. There is also a tutorial about nuget package restore available.

Contains tasks for updating NuGet packages including assembly hint paths in the project files using the nuget.exe update command.

Contains options to run Coverlet as part of dotnet test.

Contains a task which can be used to run DotCover on .NET assemblies.

Contains a task to run machine.specifications tests.

Contains tasks to run MSTest unit tests.

Contains tasks to run NUnit unit tests.

Sample

1: 
2: 
3: 
4: 
5: 
6: 

   Target.create "Test" (fun _ ->
       !! (testDir + "/NUnit.Test.*.dll")
         |> NUnit3.run (fun p ->
             {p with
                   ShadowCopy = false })
   )

Contains tasks to run xUnit v2 unit tests.

Contains tasks to run Expecto unit tests.

Contains a task which can be used to run OpenCover on .NET assemblies.

Contains a task which allows to run SpecFlow tests.

Contains a task which allows to run SpecFlow tests with SpecFlow v2.4+.

Contains tasks to run VSTest unit tests.

Contains types and utility functions relaited to running NUnit unit tests.

Contains tasks to run NUnit unit tests in parallel.

Contains tasks to run NUnit unit tests.

Contains types and functions for working with NUnit unit tests result xml.

This module is part of the Fake.IO.FileSystem package

Contains helper function which allow to deal with files and directories.

NOTE: Maybe this should be an extra module? Contains basic templating functions. Used in other helpers.

This module contains helper function to create and extract zip archives.

This module contains a file pattern globbing implementation. This module is part of the Fake.IO.FileSystem package

Contains operators to find and process files. This module is part of the Fake.IO.FileSystem package

Simple glob using as list

1: 
2: 
3: 
4: 
5: 
6: 

#r "paket: nuget Fake.IO.FileSystem //"
open Fake.IO.Globbing.Operators
let csProjectFiles = !! "src/*.csproj"

for projectFile in csProjectFiles do
    printf "F# ProjectFile: %s" projectFile

Combine globs

1: 
2: 
3: 
4: 
5: 
6: 
7: 
8: 
9: 

#r "paket: nuget Fake.IO.FileSystem //"
open Fake.IO.Globbing.Operators
let projectFiles =
    !! "src/*/*.*proj"
    ++ "src/*/*.target"
    -- "src/*/*.vbproj"

for projectFile in projectFiles do
    printf "ProjectFile: %s" projectFile

Forward globs to tasks

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 

#r "paket:
nuget Fake.Core.Target
nuget Fake.IO.FileSystem //"
open Fake.Core
open Fake.IO
open Fake.IO.Globbing.Operators
Target.create "Clean" (fun _ ->
   !! "src/*/*/obj/**/*.nuspec"
   |> File.deleteAll
)

This module contains helper functions to create Inno Setup installers.

Contains types and utility functions related to creating Squirrel installer.

Contains tasks to create msi installers using the WiX toolset

Helpers to run the npm tool.

Helpers to run the typeScript compiler.

Helpers for running the yarn tool

HTTP Client for downloading files

Contains helpers which allow to upload a whole folder/specific file into a FTP Server. Uses Passive Mode FTP and handles all files as binary (and not ASCII). Assumes direct network connectivity to destination FTP server (not via a proxy). Does not support FTPS and SFTP.

Contains a task which allows to perform SSH operations

Contains helper functions which allow to interact with the F# Interactive.

Contains helper functions which allow to interact with the F# Interactive.

This module contains functions which allow to read and write environment variables and build parameters

Contains basic functions for string manipulation.

Contains helper functions which allow to interact with the F# Interactive.

Contains helper functions which allow to interact with the F# Interactive.

Contains basic functions for string manipulation.

This module is to provide tooling support for FAKE scripts and provide common operations

This module contains function which allow to trace build output

Contains helpers around deploying databases.

Contains helpers around deploying databases.

Contains tasks to run Fixie unit tests.

Contains a task which can be used to run ReportGenerator, which converts XML reports generated by PartCover, OpenCover or NCover into a readable report in various formats.

Contains a task to run the SonarQube static code analyzer. It uses the SonarScanner for MSBuild

Contains tasks to run the Pickles living documentation generator

Helpers for running rsync tool

Under windows you will need to add it yourself to your system or use something like cygwin/babun

The SignTool tool is a command-line tool that digitally signs files, verifies signatures in files, or time stamps files.

Documentation & samples

Contains helper functions which allow to deal with git branches.

Contains helpers which allow to interact with git via the command line.

Contains helper functions which allow to commit to git repositories.

Contains helper functions which allow to get and set the git commit message.

Contains helper functions which can be used to retrieve file status information from git.

Contains helper functions which can be used to retrieve status information from git.

Contains helper functions which allow to deal with git merge.

Contains helper functions which allow to deal with git rebase.

Contains functions which allow basic operations on git repositories. All operations assume that the CommandHelper can find git.exe.

Contains helper functions which allow to deal with git reset.

Contains functions which allow the SHA1 of a file with git and without it.

Contains helper function which can be used for sanity checks.

Contains helper functions which allow to deal with git's staging area.

Contains helper functions which allow to deal with git stash.

Contains helper functions which allow to deal with git submodules.

Contains tasks which allow to call Chocolatey

Contains functions which allow to read and write information from/to the registry.