Note: This API documentation is for FAKE version 4. The migration API documentation can be found here. The API documentation for the new fake 5 modules can be found here

AppVeyorEnvironment

AppVeyor environment variables as described

Static members

Static memberDescription
AppVeyorEnvironment.AccountName
Signature: string

AppVeyor Account Name
AppVeyorEnvironment.ApiUrl
Signature: string

AppVeyor Build Agent API URL
AppVeyorEnvironment.ArtifactUploadTimeout(...)
Signature: string

Artifact upload timeout in seconds. Default is 600 (10 minutes)
AppVeyorEnvironment.BuildFolder
Signature: string

Path to clone directory
AppVeyorEnvironment.BuildId
Signature: string

AppVeyor unique build ID
AppVeyorEnvironment.BuildNumber
Signature: string

Build number
AppVeyorEnvironment.BuildVersion
Signature: string

Build version
AppVeyorEnvironment.BuildWorkerImage
Signature: string

Current build worker image the build is running on, e.g. Visual Studio 2015
AppVeyorEnvironment.CacheEntryUploadDownloadTimeout(...)
Signature: string

Timeout in seconds to download or upload each cache entry. Default is 300 (5 minutes)
AppVeyorEnvironment.CacheSkipRestore
Signature: string

set to true to disable cache restore
AppVeyorEnvironment.CacheSkipSave
Signature: string

set to true to disable cache update
AppVeyorEnvironment.Configuration
Signature: string

Configuration name set on Build tab of project settings (or through configuration parameter in appveyor.yml).
AppVeyorEnvironment.FileDownloadTimeout
Signature: string

Timeout in seconds to download arbirtary files using appveyor DownloadFile command. Default is 300 (5 minutes)
AppVeyorEnvironment.IsForcedBuild
Signature: string

If the build has been started by the "New Build" button or from the same API
AppVeyorEnvironment.IsReBuild
Signature: string

If the build has been started by the "Re-Build commit/PR" button or from the same API
AppVeyorEnvironment.IsScheduledBuild
Signature: string

If the build runs by scheduler;
AppVeyorEnvironment.JobId
Signature: string

AppVeyor unique job ID
AppVeyorEnvironment.JobName
Signature: string

The job name
AppVeyorEnvironment.JobNumber
Signature: string

The Job Number
AppVeyorEnvironment.Platform
Signature: string

Platform name set on Build tab of project settings (or through platform parameter in appveyor.yml).
AppVeyorEnvironment.ProjectId
Signature: string

AppVeyor unique project ID
AppVeyorEnvironment.ProjectName
Signature: string

Project name
AppVeyorEnvironment.ProjectSlug
Signature: string

Project slug (as seen in project details URL)
AppVeyorEnvironment.PullRequestNumber
Signature: string

GitHub Pull Request number
AppVeyorEnvironment.PullRequestTitle
Signature: string

GitHub Pull Request title
AppVeyorEnvironment.RepoBranch
Signature: string

Build branch
AppVeyorEnvironment.RepoCommit
Signature: string

Commit ID (SHA)
AppVeyorEnvironment.RepoCommitAuthor
Signature: string

Commit author's name
AppVeyorEnvironment.RepoCommitAuthorEmail(...)
Signature: string

Commit author's email address
AppVeyorEnvironment.RepoCommitMessage
Signature: string

Commit message
AppVeyorEnvironment.RepoCommitMessageExtended(...)
Signature: string

The rest of the commit message after line break (if exists)
AppVeyorEnvironment.RepoCommitTimestamp
Signature: string

Commit date/time
AppVeyorEnvironment.RepoName
Signature: string

Repository name in format owner-name/repo-name
AppVeyorEnvironment.RepoProvider
Signature: string

GitHub, BitBucket or Kiln
AppVeyorEnvironment.RepoScm
Signature: string

git or mercurial
AppVeyorEnvironment.RepositoryShallowCloneTimeout(...)
Signature: string

Timeout in seconds to download repository (GitHub, Bitbucket or VSTS) as zip file (shallow clone). Default is 1800 (30 minutes)
AppVeyorEnvironment.RepoTag
Signature: bool

true if build has started by pushed tag; otherwise false
AppVeyorEnvironment.RepoTagName
Signature: string

contains tag name for builds started by tag