Environment (Fake)

AppVeyor.Environment Type

Namespace: Fake.BuildServer
Assembly: Fake.BuildServer.AppVeyor.dll
Parent Module: AppVeyor
Base Type: obj

Exported environment variables during build. See the official documentation for details.

Static members

Static member	Description
`Environment.AccountName` Full Usage: `Environment.AccountName` Returns: `string`	AppVeyor Account Name Returns: `string`
`Environment.ApiUrl` Full Usage: `Environment.ApiUrl` Returns: `string`	AppVeyor Build Agent API URL Returns: `string`
`Environment.ArtifactUploadTimeout` Full Usage: `Environment.ArtifactUploadTimeout` Returns: `string`	Artifact upload timeout in seconds. Default is 600 (10 minutes) Returns: `string`
`Environment.BuildFolder` Full Usage: `Environment.BuildFolder` Returns: `string`	Path to clone directory Returns: `string`
`Environment.BuildId` Full Usage: `Environment.BuildId` Returns: `string`	AppVeyor unique build ID Returns: `string`
`Environment.BuildNumber` Full Usage: `Environment.BuildNumber` Returns: `string`	Build number Returns: `string`
`Environment.BuildVersion` Full Usage: `Environment.BuildVersion` Returns: `string`	Build version Returns: `string`
`Environment.BuildWorkerImage` Full Usage: `Environment.BuildWorkerImage` Returns: `string`	Current build worker image the build is running on, e.g. Visual Studio 2015 Returns: `string`
`Environment.CacheEntryUploadDownloadTimeout` Full Usage: `Environment.CacheEntryUploadDownloadTimeout` Returns: `string`	Timeout in seconds to download or upload each cache entry. Default is 300 (5 minutes) Returns: `string`
`Environment.CacheSkipRestore` Full Usage: `Environment.CacheSkipRestore` Returns: `string`	set to true to disable cache restore Returns: `string`
`Environment.CacheSkipSave` Full Usage: `Environment.CacheSkipSave` Returns: `string`	set to true to disable cache update Returns: `string`
`Environment.Configuration` Full Usage: `Environment.Configuration` Returns: `string`	Configuration name set on Build tab of project settings (or through configuration parameter in appveyor.yml). Returns: `string`
`Environment.FileDownloadTimeout` Full Usage: `Environment.FileDownloadTimeout` Returns: `string`	Timeout in seconds to download arbirtary files using appveyor DownloadFile command. Default is 300 (5 minutes) Returns: `string`
`Environment.IsForcedBuild` Full Usage: `Environment.IsForcedBuild` Returns: `string`	If the build has been started by the "New Build" button or from the same API Returns: `string`
`Environment.IsReBuild` Full Usage: `Environment.IsReBuild` Returns: `string`	If the build has been started by the "Re-Build commit/PR" button or from the same API Returns: `string`
`Environment.IsScheduledBuild` Full Usage: `Environment.IsScheduledBuild` Returns: `string`	If the build runs by scheduler; Returns: `string`
`Environment.JobId` Full Usage: `Environment.JobId` Returns: `string`	AppVeyor unique job ID Returns: `string`
`Environment.JobName` Full Usage: `Environment.JobName` Returns: `string`	The job name Returns: `string`
`Environment.JobNumber` Full Usage: `Environment.JobNumber` Returns: `string`	The Job Number Returns: `string`
`Environment.Platform` Full Usage: `Environment.Platform` Returns: `string`	Platform name set on Build tab of project settings (or through platform parameter in appveyor.yml). Returns: `string`
`Environment.ProjectId` Full Usage: `Environment.ProjectId` Returns: `string`	AppVeyor unique project ID Returns: `string`
`Environment.ProjectName` Full Usage: `Environment.ProjectName` Returns: `string`	Project name Returns: `string`
`Environment.ProjectSlug` Full Usage: `Environment.ProjectSlug` Returns: `string`	Project slug (as seen in project details URL) Returns: `string`
`Environment.PullRequestNumber` Full Usage: `Environment.PullRequestNumber` Returns: `string`	Pull (Merge) Request number Returns: `string`
`Environment.PullRequestTitle` Full Usage: `Environment.PullRequestTitle` Returns: `string`	Pull (Merge) Request title Returns: `string`
`Environment.RepoBranch` Full Usage: `Environment.RepoBranch` Returns: `string`	Build branch Returns: `string`
`Environment.RepoCommit` Full Usage: `Environment.RepoCommit` Returns: `string`	Commit ID (SHA) Returns: `string`
`Environment.RepoCommitAuthor` Full Usage: `Environment.RepoCommitAuthor` Returns: `string`	Commit author's name Returns: `string`
`Environment.RepoCommitAuthorEmail` Full Usage: `Environment.RepoCommitAuthorEmail` Returns: `string`	Commit author's email address Returns: `string`
`Environment.RepoCommitMessage` Full Usage: `Environment.RepoCommitMessage` Returns: `string`	Commit message Returns: `string`
`Environment.RepoCommitMessageExtended` Full Usage: `Environment.RepoCommitMessageExtended` Returns: `string`	The rest of the commit message after line break (if exists) Returns: `string`
`Environment.RepoCommitTimestamp` Full Usage: `Environment.RepoCommitTimestamp` Returns: `string`	Commit date/time Returns: `string`
`Environment.RepoName` Full Usage: `Environment.RepoName` Returns: `string`	Repository name in format owner-name/repo-name Returns: `string`
`Environment.RepoProvider` Full Usage: `Environment.RepoProvider` Returns: `string`	gitHub, bitBucket, kiln, vso, gitLab, gitHubEnterprise, gitLabEnterprise, stash, gitea, git, mercurial or subversion Returns: `string`
`Environment.RepoScm` Full Usage: `Environment.RepoScm` Returns: `string`	git or mercurial Returns: `string`
`Environment.RepoTag` Full Usage: `Environment.RepoTag` Returns: `bool`	true if build has started by pushed tag; otherwise false Returns: `bool`
`Environment.RepoTagName` Full Usage: `Environment.RepoTagName` Returns: `string`	contains tag name for builds started by tag Returns: `string`
`Environment.RepositoryShallowCloneTimeout` Full Usage: `Environment.RepositoryShallowCloneTimeout` Returns: `string`	Timeout in seconds to download repository (GitHub, Bitbucket or VSTS) as zip file (shallow clone). Default is 1800 (30 minutes) Returns: `string`