Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

OBSOLETE

Use Fake.Windows.Choco instead

Choco

Contains tasks which allow to call Chocolatey

Nested types and modules

TypeDescription
ChocoInstallParams
OBSOLETE

Use Fake.Windows.Choco instead

The choco install parameter type.

ChocoPackParams
OBSOLETE

Use Fake.Windows.Choco instead

The choco pack parameter type.

ChocoPushParams
OBSOLETE

Use Fake.Windows.Choco instead

The choco push parameter type.

ChocolateyChecksumType
OBSOLETE

Use Fake.Windows.Choco instead

ChocolateyInstallerType
OBSOLETE

Use Fake.Windows.Choco instead

NuspecData
OBSOLETE

Use Fake.Windows.Choco instead

Functions and values

Function or valueDescription
appendFormattedLine format value builder
Signature: format:StringFormat<('?8876 -> string)> -> value:'?8876 -> builder:StringBuilder -> StringBuilder
Type parameters: '?8876
appendFormattedLineIfNotNull(...)
Signature: format:StringFormat<('?8878 -> string)> -> value:'?8878 -> builder:StringBuilder -> StringBuilder
Type parameters: '?8878
appendLine line builder
Signature: line:string -> builder:StringBuilder -> StringBuilder
callChocoPack nuspecFile parameters
Signature: nuspecFile:string -> parameters:ChocoPackParams -> unit
checksumTypeToString(x)
Signature: x:'?8885 -> string
Type parameters: '?8885
ChocoInstallDefaults
Signature: ChocoInstallParams
Attributes:
[<Obsolete("Use Fake.Windows.Choco instead")>]
OBSOLETE

Use Fake.Windows.Choco instead

The default option set given to choco install.

ChocoPackDefaults
Signature: ChocoPackParams
Attributes:
[<Obsolete("Use Fake.Windows.Choco instead")>]
OBSOLETE

Use Fake.Windows.Choco instead

The default option set given to choco pack.

ChocoPushDefaults
Signature: ChocoPushParams
Attributes:
[<Obsolete("Use Fake.Windows.Choco instead")>]
OBSOLETE

Use Fake.Windows.Choco instead

The default option set given to choco push.

createChocolateyInstallPs1(...)
Signature: parameters:ChocoPackParams -> outputDir:string -> unit
createChocolateyInstallPs1FromTemplate(...)
Signature: parameters:ChocoPackParams -> templatePath:string -> outputDir:string -> unit
createChocolateyUninstallPs1(...)
Signature: parameters:ChocoPackParams -> outputDir:string -> unit
createChocolateyUninstallPs1FromTemplate(...)
Signature: parameters:ChocoPackParams -> templatePath:string -> outputDir:string -> unit
getNuspecData(parameters)
Signature: parameters:ChocoPackParams -> NuspecData
getPaths
Signature: seq<string> list
Attributes:
[<Obsolete("Use Fake.Windows.Choco instead")>]
OBSOLETE

Use Fake.Windows.Choco instead

getTempFolder
Signature: string
Install setParams packages
Signature: setParams:(ChocoInstallParams -> ChocoInstallParams) -> packages:string -> unit
Attributes:
[<Obsolete("Use Fake.Windows.Choco instead")>]
OBSOLETE

Use Fake.Windows.Choco instead

Call choco to install a package

Parameters

  • setParams - Function used to manipulate the default choco parameters. See ChocoInstallParams

  • packages - Names of packages, path to packages.config, .nuspec or .nupkg to install

    Sample usage

    Target "ChocoInstall" (fun _ -> "pretzel" |> Choco.Install (fun p -> { p with Version = "0.4.0" }) )

installerTypeToString(x)
Signature: x:'?8883 -> string
Type parameters: '?8883
IsAvailable
Signature: bool
Attributes:
[<Obsolete("Use Fake.Windows.Choco instead")>]
OBSOLETE

Use Fake.Windows.Choco instead

True if choco is available (only on windows)

Sample usage

1: 
"Build" =?> ("ChocoInstall", Choco.IsAvailable)
Pack(setParams)
Signature: setParams:(ChocoPackParams -> ChocoPackParams) -> unit
Attributes:
[<Obsolete("Use Fake.Windows.Choco instead")>]
OBSOLETE

Use Fake.Windows.Choco instead

Call choco to pack a package and create .nuspec, chocolateyInstall.ps1 and chocolateyUninstall.ps1 if informations are specified

Parameters

  • setParams - Function used to manipulate the default choco parameters. See ChocoPackParams

    Sample usage

    Target "ChocoPack" (fun _ -> Choco.Pack (fun p -> { p with Version = "0.5.0"; ... }) )

PackFromTemplate setParams nuspecPath
Signature: setParams:(ChocoPackParams -> ChocoPackParams) -> nuspecPath:string -> unit
Attributes:
[<Obsolete("Use Fake.Windows.Choco instead")>]
OBSOLETE

Use Fake.Windows.Choco instead

Call choco to pack a package

Parameters

  • setParams - Function used to manipulate the default choco parameters. See ChocoPackParams

  • nuspecPath - path to the .nuspec to pack

    Sample usage

    Target "ChocoPack" (fun _ -> "pretzel.nuspec" |> Choco.Pack (fun p -> { p with Version = "0.5.0" }) )

Push setParams nupkgPath
Signature: setParams:(ChocoPushParams -> ChocoPushParams) -> nupkgPath:string -> unit
Attributes:
[<Obsolete("Use Fake.Windows.Choco instead")>]
OBSOLETE

Use Fake.Windows.Choco instead

Call choco to push a package

Parameters

  • setParams - Function used to manipulate the default choco parameters. See ChocoPushParams

  • nupkgPath - path to the .nupkg to push

    Sample usage

    Target "ChocoPush" (fun _ -> "pretzel.0.5.0.nupkg" |> Choco.Push (fun p -> { p with ApiKey = "123-123123-123" }) )