JenkinsRepositoryInfo Class

Summary

Provides Jenkins repository information for the current build.
Namespace
Cake.Common.Build.Jenkins.Data
Base Types
graph BT Type-->Base0["JenkinsInfo"] click Base0 "/api/Cake.Common.Build.Jenkins/JenkinsInfo" Base0-->Base1["object"] Type["JenkinsRepositoryInfo"] class Type type-node

Syntax

public sealed class JenkinsRepositoryInfo : JenkinsInfo

Constructors

Name Summary
JenkinsRepositoryInfo(ICakeEnvironment) Initializes a new instance of the JenkinsRepositoryInfo class.

Properties

Name Value Summary
BranchName string
Gets the branch name which will be build in a multibranch project.
CvsBranch string
Gets the CVS branch.
GitBranch string
Gets the Git branch.
GitCheckoutDirectory string
Gets the Git checkout directory.
GitCommitSha string
Gets the Git commit sha.
GitLocalBranch string
Gets the Git local branch.
GitPreviousCommitSha string
Gets the previous Git commit sha.
GitPreviousSuccessfullCommitSha string
Gets the previous successfull Git commit sha.
GitUrl string
Gets the Git remote URL.
MercurialRepositoryUrl string
Gets the Mercurial repository URL.
MercurialRevision string
Gets the full id of the Mercurial revision.
MercurialRevisionBranch string
Gets the Mercurial revision branch.
MercurialRevisionNumber string
Gets the Mercurial revision number.
MercurialRevisionShort string
Gets the abbreviated id of the Mercurial revision.
SvnRevision string
Gets the SVN revision.
SvnUrl string
Gets the SVN URL.

Methods

Name Value Summary
GetEnvironmentBoolean(string) bool
Gets an environment variable as a bool.
Inherited from JenkinsInfo
GetEnvironmentInteger(string) int
Gets an environment variable as a int.
Inherited from JenkinsInfo
GetEnvironmentString(string) string
Gets an environment variable as a string.
Inherited from JenkinsInfo

Extension Methods

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