FAKE - F# Make - A DSL for build tasks and more FAKE
6.0.0-alpha004

Lookig for older versions of the documentation, pre FAKE v6? See 

v5.fake.build

Fake.Core Namespace

Core namespace contains FAKE's core tasks, like Target, Process, BuildeServer, etc.. modules.

Type/Module Description

Args

Helper functions for proper command line parsing

Arguments (Module)

Module for working with an `Arguments` instance

Arguments (Type)

Represents a list of arguments

AsyncProcessResult<'a>

BuildFailedException

Exception for request errors

BuildServer (Module)

Contains functions which allow build scripts to interact with a build server.

BuildServer (Type)

The server type option.

BuildServerInstaller

Changelog

Contains helpers which allow to parse Change log text files. These files have to be in a format as described on keepachangelog

Command

The type of command to execute

ConsoleMessage

A record type which captures console messages

ConsoleTraceListener

Implements a TraceListener for System.Console.

ConsoleWriter

Context

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)

CoreTracing

CreateProcess

Module for creating and modifying CreateProcess<'TRes> instances.

CreateProcess<'TRes>

Handle for creating a process and returning potential results.

CreateProcessDotNetExt

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

CreateProcessExt

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

DataRef<'T>

Represents basically an "out" parameter, allows to retrieve a value after a certain point in time. Used to retrieve "pipes"

DocHelper

Docopt

DocoptException

DocoptMap

DocoptResult (Module)

DocoptResult (Type)

DotNetCoverageTool

The list of DotNet coverage tools supported Please consider not using a match on this type in code external to the fake repository.

Environment

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

EnvMap (Module)

EnvMap (Type)

ExecParams

Parameter type for process execution.

FakeVar

This module contains helpers for managing build time variables

FilePath

IMap

IMap<'TKey, 'TValue>

ImportData

The types of data to import in build process Please consider not using a match on this type in code external to the fake repository.

ITraceListener

Defines a TraceListener interface Note: Please contribute implementations to the fake repository, as external implementations are not supported.

KnownTags

The supported tracing tags Please consider not using a match on this type in code external to the fake repository.

Mono

NunitDataVersion

The NUnit versions supported Please consider not using a match on this type in code external to the fake repository.

Operators

PreRelease

Information about PreRelease packages.

PreReleaseSegment

Proc

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

Process

Contains functions which can be used to start other tools.

ProcessOutput

The output of the process. If ordering between stdout and stderr is important you need to use streams.

ProcessResult

A process result including error code, message log and errors.

ProcessResult<'a>

ProcessUtils

Contains functions which can be used to start other tools.

ProcStartInfo

The process start info, a type used to define a process configurations, options and arguments

ProcStartInfoExtensions

An extension to process start info type

RawProcessResult

ReleaseNotes

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

SemVer

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.

SemVerActivePattern

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

SemVerInfo

Contains the version information. For parsing use SemVer.parse

Shell

Allows to exec shell operations synchronously and asynchronously.

StartedProcessInfo

Some information regarding the started process

StreamExtensions

StreamRef

StreamSpecification

Various options to redirect streams.

String

Contains basic functions for string manipulation.

StringBuilder

FAKE's StringBuilder module.

TagStatus

The types of tagging on testing supported Please consider not using a match on this type in code external to the fake repository.

Target

FAKE Target module contains tasks to define and run targets.

TargetContext

TargetOperators

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

TargetParameter

TargetResult

TaskRunner

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

TestStatus (Module)

Testing status

TestStatus (Type)

The testing statuses supported Please consider not using a match on this type in code external to the fake repository.

Trace

This module contains function which allow to trace build output

TraceData (Module)

TraceData (Type)

Defines Tracing information for TraceListeners Please consider not using a match on this type in code external to the fake repository.

TraceMode

The trace mode option.

TraceSecret

TraceSecrets

Module to handle tracing secret values in logs

UserInput

Contains tasks for capturing user input

Vault

Provides a encrypted store of variables to prevent accidental leakage Please read the documentation

VaultExt

Summary> An extenstion type for Vault module.

Xml

Contains functions to read and write XML files.