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

Open Fake.Tools instead (FAKE0001 - package: Fake.Tools.Pickles, module: Pickles, type: PicklesParams)

PicklesParams

The Pickles parameter type

Record Fields

Record FieldDescription
ErrorLevel
Signature: PicklesErrorLevel

Option which allows to specify if failure of pickles should break the build.

FeatureDirectory
Signature: string

The directory to start scanning recursively for features

FeatureFileLanguage
Signature: string option

The language of the feature files

IncludeExperimentalFeatures
Signature: bool option

Option which allows to enable some experimental features

LinkedTestResultFiles
Signature: string list

the paths to the linked test results files

OutputDirectory
Signature: string

The directory where output files will be placed

OutputFileFormat
Signature: DocumentationFormat

The format of the output documentation

SystemUnderTestName
Signature: string option

The name of the system under test

SystemUnderTestVersion
Signature: string option

The version of the system under test

TestResultsFormat
Signature: TestResultsFormat

the format of the linked test results

TimeOut
Signature: TimeSpan

Maximum time to allow xUnit to run before being killed.

ToolPath
Signature: string

The path to the Pickles console tool: 'pickles.exe'