GitVersioningCloudSettings Class

Summary

Defines settings for the Cake.GitVersioning.GitVersioningAliases.GitVersioningCloud(Cake.Core.ICakeContext,System.String,Cake.GitVersioning.GitVersioningCloudSettings) alias.
Assembly
Cake.GitVersioning.dll
Namespace
Cake.GitVersioning
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["GitVersioningCloudSettings"] class Type type-node

Syntax

public class GitVersioningCloudSettings

Attributes

Type Description
NullableContextAttribute
NullableAttribute

Constructors

Properties

Name Value Summary
AdditionalVariables Dictionary<string, string>
Gets additional cloud build variables to define.
AllVariables bool
Gets or sets a value indicating whether to define ALL version variables as cloud build variables, with a "NBGV_" prefix.
CISystem Nullable<GitVersioningCloudProvider>
Gets or sets a a particular CI system to force usage of. If not specified, auto-detection will be used.
CommonVariables bool
Gets or sets a value indicating whether to define a few common version variables as cloud build variables, with a "Git" prefix.
Metadata List<string>
Gets a list of identifiers to include with the build metadata part of a semantic version.
Version string
Gets or sets the string to use for the cloud build number. If no value is specified, the computed version will be used.

Extension Methods

Name Value Summary
Dump<GitVersioningCloudSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<GitVersioningCloudSettings>(GitVersioningCloudSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<GitVersioningCloudSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<GitVersioningCloudSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<GitVersioningCloudSettings>(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<GitVersioningCloudSettings>(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