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

please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor instead

AppVeyor

Contains code to configure FAKE for AppVeyor integration

Nested types and modules

TypeDescription
AppVeyorEnvironment
OBSOLETE

please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead

AppVeyor environment variables as described

ArtifactType
OBSOLETE

This type should no longer be required (use 'Fake.BuildServer.AppVeyor').

Type of artifact that is pushed

PushArtifactParams
OBSOLETE

This type should no longer be required (use 'Fake.BuildServer.AppVeyor').

AppVeyor parameters for artifact push as described

TestResultsType
OBSOLETE

This type should no longer be required (use 'Fake.BuildServer.AppVeyor').

Union type representing the available test result formats accepted by AppVeyor.

UpdateBuildParams
OBSOLETE

This should no longer be required (use 'Fake.BuildServer.AppVeyor').

AppVeyor parameters for update build as described

Functions and values

Function or valueDescription
add msg category
Signature: msg:string -> category:string -> unit
addNoCategory(msg)
Signature: msg:string -> unit
appendArgIfNotNullOrEmpty(...)
Signature: value:string -> name:string -> builder:StringBuilder -> StringBuilder
defaultPushArtifactParams
Signature: PushArtifactParams
Attributes:
[<Obsolete("This should no longer be required (use 'Fake.BuildServer.AppVeyor').")>]
OBSOLETE

This should no longer be required (use 'Fake.BuildServer.AppVeyor').

AppVeyor artifact push default parameters

defaultUpdateBuildParams
Signature: UpdateBuildParams
FinishTestCase(...)
Signature: testSuiteName:string -> testCaseName:string -> duration:TimeSpan -> unit
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', install the build-server and use 'use dis = Trace.traceTag (KnownTags.Test name)' instead")>]
OBSOLETE

please use nuget 'Fake.BuildServer.AppVeyor', install the build-server and use 'use dis = Trace.traceTag (KnownTags.Test name)' instead

Finishes the test case.

FinishTestSuite(testSuiteName)
Signature: testSuiteName:'a -> unit
Type parameters: 'a Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', install the build-server and use 'use dis = Trace.traceTag (KnownTags.TestSuite name)' instead")>]
OBSOLETE

please use nuget 'Fake.BuildServer.AppVeyor', install the build-server and use 'use dis = Trace.traceTag (KnownTags.TestSuite name)' instead

Finishes the test suite.

IgnoreTestCase(...)
Signature: testSuiteName:string -> testCaseName:string -> message:'a -> unit
Type parameters: 'a Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', install the build-server and use 'Trace.testStatus testName (TestStatus.Ignore(message))' instead")>]
OBSOLETE

please use nuget 'Fake.BuildServer.AppVeyor', install the build-server and use 'Trace.testStatus testName (TestStatus.Ignore(message))' instead

Ignores the test case.

PushArtifact(setParams)
Signature: setParams:(PushArtifactParams -> PushArtifactParams) -> unit
Attributes:
[<Obsolete("This should no longer be required (install 'Fake.BuildServer.AppVeyor') and use 'Trace.publish ImportData.BuildArtifact file'.")>]
OBSOLETE

This should no longer be required (install 'Fake.BuildServer.AppVeyor') and use 'Trace.publish ImportData.BuildArtifact file'.

Push an artifact

PushArtifacts(paths)
Signature: paths:seq<string> -> unit
Attributes:
[<Obsolete("This should no longer be required (install 'Fake.BuildServer.AppVeyor') and use 'Trace.publish ImportData.BuildArtifact file'.")>]
OBSOLETE

This should no longer be required (install 'Fake.BuildServer.AppVeyor') and use 'Trace.publish ImportData.BuildArtifact file'.

Push multiple artifacts

sendToAppVeyor(args)
Signature: args:string -> unit
SetVariable name value
Signature: name:string -> value:string -> unit
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.setVariable instead")>]
OBSOLETE

please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.setVariable instead

Set environment variable

StartTestCase testSuiteName testCaseName
Signature: testSuiteName:string -> testCaseName:string -> unit
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', install the build-server and use 'use dis = Trace.traceTag (KnownTags.Test name)' instead")>]
OBSOLETE

please use nuget 'Fake.BuildServer.AppVeyor', install the build-server and use 'use dis = Trace.traceTag (KnownTags.Test name)' instead

Starts the test case.

StartTestSuite(testSuiteName)
Signature: testSuiteName:'a -> unit
Type parameters: 'a Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', install the build-server and use 'use dis = Trace.traceTag (KnownTags.TestSuite name)' instead")>]
OBSOLETE

please use nuget 'Fake.BuildServer.AppVeyor', install the build-server and use 'use dis = Trace.traceTag (KnownTags.TestSuite name)' instead

Starts the test suite.

TestFailed(...)
Signature: testSuiteName:string -> testCaseName:string -> message:string -> details:string -> unit
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', install the build-server and use 'Trace.testStatus testName (TestStatus.Failed(message, details, None))' instead")>]
OBSOLETE

please use nuget 'Fake.BuildServer.AppVeyor', install the build-server and use 'Trace.testStatus testName (TestStatus.Failed(message, details, None))' instead

Reports a failed test.

TestSucceeded testSuiteName testCaseName
Signature: testSuiteName:string -> testCaseName:string -> unit
Attributes:
[<Obsolete("please remove this call, success is implicit.")>]
OBSOLETE

please remove this call, success is implicit.

Reports a succeeded test.

UpdateBuild(setParams)
Signature: setParams:(UpdateBuildParams -> UpdateBuildParams) -> unit
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.updateBuild instead")>]
OBSOLETE

please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.updateBuild instead

Update build details

UpdateBuildVersion(version)
Signature: version:string -> unit
Attributes:
[<Obsolete("This should no longer be required (install 'Fake.BuildServer.AppVeyor') and use 'Trace.setBuildNumber version'.")>]
OBSOLETE

This should no longer be required (install 'Fake.BuildServer.AppVeyor') and use 'Trace.setBuildNumber version'.

Update build version. This must be unique for the current project.

UploadTestResultsFile(...)
Signature: testResultsType:TestResultsType -> file:string -> unit
Attributes:
[<Obsolete("This should no longer be required (install 'Fake.BuildServer.AppVeyor') and use 'Trace.publish (ImportData.<type>) file'.")>]
OBSOLETE

This should no longer be required (install 'Fake.BuildServer.AppVeyor') and use 'Trace.publish (ImportData.<type>) file'.

Uploads a test result file to make them visible in Test tab of the build console.

UploadTestResultsXml(...)
Signature: testResultsType:TestResultsType -> outputDir:string -> unit
Attributes:
[<Obsolete("This should no longer be required (install 'Fake.BuildServer.AppVeyor') and use 'Trace.publish (ImportData.<type>) file'.")>]
OBSOLETE

This should no longer be required (install 'Fake.BuildServer.AppVeyor') and use 'Trace.publish (ImportData.<type>) file'.

Uploads all the test results ".xml" files in a directory to make them visible in Test tab of the build console.