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

Environment

AppVeyor environment variables as described

Static members

Static memberDescription
Environment.AccountName
Signature: string

AppVeyor Account Name

Environment.ApiUrl
Signature: string

AppVeyor Build Agent API URL

Environment.ArtifactUploadTimeout
Signature: string

Artifact upload timeout in seconds. Default is 600 (10 minutes)

Environment.BuildFolder
Signature: string

Path to clone directory

Environment.BuildId
Signature: string

AppVeyor unique build ID

Environment.BuildNumber
Signature: string

Build number

Environment.BuildVersion
Signature: string

Build version

Environment.BuildWorkerImage
Signature: string

Current build worker image the build is running on, e.g. Visual Studio 2015

Environment.CacheEntryUploadDownloadTimeout(...)
Signature: string

Timeout in seconds to download or upload each cache entry. Default is 300 (5 minutes)

Environment.CacheSkipRestore
Signature: string

set to true to disable cache restore

Environment.CacheSkipSave
Signature: string

set to true to disable cache update

Environment.Configuration
Signature: string

Configuration name set on Build tab of project settings (or through configuration parameter in appveyor.yml).

Environment.FileDownloadTimeout
Signature: string

Timeout in seconds to download arbirtary files using appveyor DownloadFile command. Default is 300 (5 minutes)

Environment.IsForcedBuild
Signature: string

If the build has been started by the "New Build" button or from the same API

Environment.IsReBuild
Signature: string

If the build has been started by the "Re-Build commit/PR" button or from the same API

Environment.IsScheduledBuild
Signature: string

If the build runs by scheduler;

Environment.JobId
Signature: string

AppVeyor unique job ID

Environment.JobName
Signature: string

The job name

Environment.JobNumber
Signature: string

The Job Number

Environment.Platform
Signature: string

Platform name set on Build tab of project settings (or through platform parameter in appveyor.yml).

Environment.ProjectId
Signature: string

AppVeyor unique project ID

Environment.ProjectName
Signature: string

Project name

Environment.ProjectSlug
Signature: string

Project slug (as seen in project details URL)

Environment.PullRequestNumber
Signature: string

GitHub Pull Request number

Environment.PullRequestRepoBranch
Signature: string

GitHub Pull Request branch

Environment.PullRequestRepoName
Signature: string

GitHub Pull Request Repo name

Environment.PullRequestTitle
Signature: string

GitHub Pull Request title

Environment.RepoBranch
Signature: string

Build branch

Environment.RepoCommit
Signature: string

Commit ID (SHA)

Environment.RepoCommitAuthor
Signature: string

Commit author's name

Environment.RepoCommitAuthorEmail
Signature: string

Commit author's email address

Environment.RepoCommitMessage
Signature: string

Commit message

Environment.RepoCommitMessageExtended
Signature: string

The rest of the commit message after line break (if exists)

Environment.RepoCommitTimestamp
Signature: string

Commit date/time

Environment.RepoName
Signature: string

Repository name in format owner-name/repo-name

Environment.RepoProvider
Signature: string

GitHub, BitBucket or Kiln

Environment.RepoScm
Signature: string

git or mercurial

Environment.RepositoryShallowCloneTimeout(...)
Signature: string

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

Environment.RepoTag
Signature: bool

true if build has started by pushed tag; otherwise false

Environment.RepoTagName
Signature: string

contains tag name for builds started by tag