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.Environment instead

AppVeyorEnvironment

AppVeyor environment variables as described

Static members

Static memberDescription
AppVeyorEnvironment.AccountName
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

AppVeyor Account Name
AppVeyorEnvironment.ApiUrl
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

AppVeyor Build Agent API URL
AppVeyorEnvironment.ArtifactUploadTimeout(...)
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

Artifact upload timeout in seconds. Default is 600 (10 minutes)
AppVeyorEnvironment.BuildFolder
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

Path to clone directory
AppVeyorEnvironment.BuildId
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

AppVeyor unique build ID
AppVeyorEnvironment.BuildNumber
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

Build number
AppVeyorEnvironment.BuildVersion
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

Build version
AppVeyorEnvironment.BuildWorkerImage
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

Current build worker image the build is running on, e.g. Visual Studio 2015
AppVeyorEnvironment.CacheEntryUploadDownloadTimeout(...)
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

Timeout in seconds to download or upload each cache entry. Default is 300 (5 minutes)
AppVeyorEnvironment.CacheSkipRestore
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

set to true to disable cache restore
AppVeyorEnvironment.CacheSkipSave
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

set to true to disable cache update
AppVeyorEnvironment.Configuration
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

Configuration name set on Build tab of project settings (or through configuration parameter in appveyor.yml).
AppVeyorEnvironment.FileDownloadTimeout
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

Timeout in seconds to download arbirtary files using appveyor DownloadFile command. Default is 300 (5 minutes)
AppVeyorEnvironment.IsForcedBuild
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

If the build has been started by the "New Build" button or from the same API
AppVeyorEnvironment.IsReBuild
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

If the build has been started by the "Re-Build commit/PR" button or from the same API
AppVeyorEnvironment.IsScheduledBuild
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

If the build runs by scheduler;
AppVeyorEnvironment.JobId
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

AppVeyor unique job ID
AppVeyorEnvironment.JobName
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

The job name
AppVeyorEnvironment.JobNumber
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

The Job Number
AppVeyorEnvironment.Platform
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

Platform name set on Build tab of project settings (or through platform parameter in appveyor.yml).
AppVeyorEnvironment.ProjectId
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

AppVeyor unique project ID
AppVeyorEnvironment.ProjectName
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

Project name
AppVeyorEnvironment.ProjectSlug
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

Project slug (as seen in project details URL)
AppVeyorEnvironment.PullRequestNumber
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

GitHub Pull Request number
AppVeyorEnvironment.PullRequestRepoBranch(...)
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

GitHub Pull Request branch
AppVeyorEnvironment.PullRequestRepoName
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

GitHub Pull Request Repo name
AppVeyorEnvironment.PullRequestTitle
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

GitHub Pull Request title
AppVeyorEnvironment.RepoBranch
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

Build branch
AppVeyorEnvironment.RepoCommit
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

Commit ID (SHA)
AppVeyorEnvironment.RepoCommitAuthor
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

Commit author's name
AppVeyorEnvironment.RepoCommitAuthorEmail(...)
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

Commit author's email address
AppVeyorEnvironment.RepoCommitMessage
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

Commit message
AppVeyorEnvironment.RepoCommitMessageExtended(...)
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

The rest of the commit message after line break (if exists)
AppVeyorEnvironment.RepoCommitTimestamp
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

Commit date/time
AppVeyorEnvironment.RepoName
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

Repository name in format owner-name/repo-name
AppVeyorEnvironment.RepoProvider
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

GitHub, BitBucket or Kiln
AppVeyorEnvironment.RepoScm
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

git or mercurial
AppVeyorEnvironment.RepositoryShallowCloneTimeout(...)
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

Timeout in seconds to download repository (GitHub, Bitbucket or VSTS) as zip file (shallow clone). Default is 1800 (30 minutes)
AppVeyorEnvironment.RepoTag
Signature: bool
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

true if build has started by pushed tag; otherwise false
AppVeyorEnvironment.RepoTagName
Signature: string
Attributes:
[<Obsolete("please use nuget 'Fake.BuildServer.AppVeyor', open Fake.BuildServer and use AppVeyor.Environment instead")>]
OBSOLETE

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

contains tag name for builds started by tag