BuildSystem Class

Summary

Provides functionality for interacting with different build systems.
Namespace
Cake.Common.Build
Base Types
  • object
graph BT Type-->Base0["object"] Type["BuildSystem"] class Type type-node

Syntax

public sealed class BuildSystem

Constructors

Name Summary
BuildSystem(IAppVeyorProvider, ITeamCityProvider, IMyGetProvider, IBambooProvider, IContinuaCIProvider, IJenkinsProvider, IBitriseProvider, ITravisCIProvider, IBitbucketPipelinesProvider, IGoCDProvider, IGitLabCIProvider, IGitHubActionsProvider, IAzurePipelinesProvider) Initializes a new instance of the BuildSystem class.

Properties

Name Value Summary
AppVeyor IAppVeyorProvider
Gets the AppVeyor Provider.
AzurePipelines IAzurePipelinesProvider
Gets the Azure Pipelines Provider.
Bamboo IBambooProvider
Gets the Bamboo Provider.
BitbucketPipelines IBitbucketPipelinesProvider
Gets the Bitbucket Pipelines Provider.
Bitrise IBitriseProvider
Gets the Bitrise Provider.
ContinuaCI IContinuaCIProvider
Gets the Continua CI Provider.
GitHubActions IGitHubActionsProvider
Gets the GitHub Actions Provider.
GitLabCI IGitLabCIProvider
Gets the GitLab CI Provider.
GoCD IGoCDProvider
Gets the Go.CD Provider.
IsLocalBuild bool
Gets a value indicating whether the current build is local build.
IsPullRequest bool
Gets a value indicating whether the current build was started by a pull request.
IsRunningOnAppVeyor bool
Gets a value indicating whether the current build is running on AppVeyor.
IsRunningOnAzurePipelines bool
Gets a value indicating whether this instance is running on Azure Pipelines.
IsRunningOnBamboo bool
Gets a value indicating whether the current build is running on Bamboo.
IsRunningOnBitbucketPipelines bool
Gets a value indicating whether this instance is running on Bitbucket Pipelines.
IsRunningOnBitrise bool
Gets a value indicating whether this instance is running on Bitrise.
IsRunningOnContinuaCI bool
Gets a value indicating whether the current build is running on Continua CI.
IsRunningOnGitHubActions bool
Gets a value indicating whether this instance is running on GitHub Actions.
IsRunningOnGitLabCI bool
Gets a value indicating whether this instance is running on GitLab CI.
IsRunningOnGoCD bool
Gets a value indicating whether the current build is running on Go.CD.
IsRunningOnJenkins bool
Gets a value indicating whether this instance is running on Jenkins.
IsRunningOnMyGet bool
Gets a value indicating whether the current build is running on MyGet.
IsRunningOnTeamCity bool
Gets a value indicating whether the current build is running on TeamCity.
IsRunningOnTravisCI bool
Gets a value indicating whether this instance is running on Travis CI.
Jenkins IJenkinsProvider
Gets the Jenkins Provider.
MyGet IMyGetProvider
Gets the MyGet Provider.
Provider BuildProvider
Gets the current build provider.
TeamCity ITeamCityProvider
Gets the TeamCity Provider.
TravisCI ITravisCIProvider
Gets the Travis CI provider.

Extension Methods

Name Value Summary
Dump<BuildSystem>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<BuildSystem>(BuildSystem[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<BuildSystem>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<BuildSystem>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<BuildSystem>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<BuildSystem>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin