Summary

Provides RWX git information for the current build.

Namespace

Cake.Common.Build.Rwx.Data

Base Types

object
RwxInfo

graph BT Type-->Base0["RwxInfo"] click Base0 "/api/Cake.Common.Build.Rwx/RwxInfo" Base0-->Base1["object"] Type["RwxGitInfo"] class Type type-node

Syntax

public sealed class RwxGitInfo : RwxInfo

Remarks

These values are populated by the RWX git/clone package and are only available to tasks that depend (directly or transitively) on a task that ran git/clone. When unavailable, properties return empty strings.

Constructors

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

Properties

Name	Value	Summary
CommitMessage	string	Gets the full message of the resolved commit.
CommitSha	string	Gets the SHA of the resolved commit.
CommitSummary	string	Gets the summary line of the resolved commit's message.
CommitterEmail	string	Gets the committer email associated with the resolved commit.
CommitterName	string	Gets the committer name associated with the resolved commit.
Ref	string	Gets the unresolved ref associated with the commit.
RefName	string	Gets the name of the unresolved ref associated with the commit.
RepositoryName	string	Gets the repository identifier extracted from the repository URL.
RepositoryUrl	string	Gets the URL of the git repository that was cloned.

Methods

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

Extension Methods

Name	Value	Summary
Dump<RwxGitInfo>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<RwxGitInfo>(RwxGitInfo[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<RwxGitInfo>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<RwxGitInfo>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<RwxGitInfo>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<RwxGitInfo>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin