CalculateSemanticVersionWithGitVersion Class

Summary

Defines a ITask that gets the semantic version information for the workspace via the GitVersion command line tool.
Namespace
NBuildKit.MsBuild.Tasks.Versions
Base Types
graph TD Base0["CommandLineToolTask"]-->Type click Base0 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/CommandLineToolTask" Base1["BaseTask"]-->Base0 click Base1 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/BaseTask" Base2["Task"]-->Base1 Type["CalculateSemanticVersionWithGitVersion"] class Type type-node

Syntax

public sealed class CalculateSemanticVersionWithGitVersion : CommandLineToolTask

Constructors

Name Summary
CalculateSemanticVersionWithGitVersion() Initializes a new instance of the CalculateSemanticVersionWithGitVersion class.
CalculateSemanticVersionWithGitVersion(IApplicationInvoker) Initializes a new instance of the CalculateSemanticVersionWithGitVersion class.

Properties

Name Value Summary
DefaultDataHandler DataReceivedEventHandler
Gets the event handler that processes data from the data stream, or standard output stream, of the command line application.By default logs a message for each output.
Inherited from CommandLineToolTask
DefaultErrorHandler DataReceivedEventHandler
Gets the event handler that processes data from the data stream, or standard output stream, of the command line application.By default logs a message for each output.
Inherited from CommandLineToolTask
ErrorInformation ITaskItem[]
Gets or sets the collection containing the error codes for the task.
Inherited from BaseTask
ExePath ITaskItem
Gets or sets the full path of the command line executable.
LogEnvironmentVariables bool
Gets or sets a value indicating whether the environment variables for the process should be logged.
Inherited from CommandLineToolTask
LogPath ITaskItem
Gets or sets the full path of the log file.
RemoteRepositoryUri string
Gets or sets the URL of the remote repository.
UserName string
Gets or sets the name of the user that should be used to connect to the remote repository. If a username is provied then the password should be made available via the 'GitPassWord' environment variable for the process.
VersionBuild string
Gets or sets the build number of the version.
VersionMajor string
Gets or sets the major number of the version.
VersionMinor string
Gets or sets the minor number of the version.
VersionPatch string
Gets or sets the patch number of the version.
VersionPrerelease string
Gets or sets the prerelease information of the semantic version.
VersionSemantic string
Gets or sets the semantic version.
VersionSemanticFull string
Gets or sets the complete semantic version, including the prerelease information.
VersionSemanticNuGet string
Gets or sets the complete semantic version following the NuGet specification.
WorkingDirectory ITaskItem
Gets or sets the full path to the working directory

Methods

Name Value Summary
ErrorCodeById(string) string
Returns the error code for the given ID.
Inherited from BaseTask
Execute() bool
GetAbsolutePath(ITaskItem) string
Returns the absolute path for the given path item.
Inherited from BaseTask
GetAbsolutePath(ITaskItem, ITaskItem) string
Returns the absolute path for the given path item.
Inherited from BaseTask
GetAbsolutePath(string) string
Returns the absolute path for the given path item.
Inherited from BaseTask
GetFullToolPath(ITaskItem) string
Returns the most complete path for the given executable tool. May return just the name of the tool if the tool path is found via the PATH environment variable.
Inherited from CommandLineToolTask
GetFullToolPath(string) string
Returns the most complete path for the given executable tool. May return just the name of the tool if the tool path is found via the PATH environment variable.
Inherited from CommandLineToolTask
InvokeCommandLineTool(ITaskItem, IEnumerable<string>, ITaskItem, DataReceivedEventHandler, DataReceivedEventHandler) int
Invokes the command line tool at the given path with the given arguments.
Inherited from CommandLineToolTask
InvokeCommandLineTool(string, IEnumerable<string>, string, DataReceivedEventHandler, DataReceivedEventHandler) int
Invokes the command line tool at the given path with the given arguments.
Inherited from CommandLineToolTask
UpdateEnvironmentVariables(StringDictionary) void
Updates the environment variables for the application prior to execution.
VerbosityForCurrentMsBuildInstance() string
Gets the verbosity that the current MsBuild instance is running at.
Inherited from BaseTask
static