Note: This API documentation is for FAKE version 4. The migration API documentation can be found here. The API documentation for the new fake 5 modules can be found here

Squirrel

Contains types and utility functions related to creating Squirrel installer.

Nested types and modules

TypeDescription
SquirrelParams

The Squirrel Console Parameters type. FAKE will use SquirrelDefaults for values not provided.

For reference, see: Squirrel Command Line Options

ModuleDescription
ResultHandling

Functions and values

Function or valueDescription
buildSquirrelArgs(...)
Signature: parameters:SquirrelParams -> nugetPackage:string -> string
createSigningArgs(parameters)
Signature: parameters:SquirrelParams -> string
SquirrelDefaults
Signature: SquirrelParams

The Squirrel default parameters.

Defaults

  • ReleaseDir - ""
  • WorkingDir - None
  • BootstrapperExe - None
  • LoadingGif - None
  • SetupIcon - None
  • NoMsi - false
  • ToolPath - The squirrel.exe path if it exists in a subdirectory of the current directory.
  • TimeOut - 10 minutes
  • SignExecutable - None
  • SigningKeyFile - None
  • SigningSecret - None
SquirrelPack setParams nugetPackage
Signature: setParams:(SquirrelParams -> SquirrelParams) -> nugetPackage:string -> unit

Creates a Squirrel installer for given NuGet package Will fail if Squirrel terminates with non-zero exit code.

Parameters

  • setParams - Function used to manipulate the default SquirrelParams value.
  • nugetPackage - The package to create an installer for

Sample usage

1: 
2: 
3: 
Target "CreatePackage" (fun _ ->
    SquirrelPack (fun p -> { p with WorkingDir = Some "./tmp" }) "./my.nupkg"
)
union case Option.Some: Value: 'T -> Option<'T>