ExtractIssueIdsFromGitCommitMessages Class

Summary

Defines a ITask that extracts the issue numbers from all the commits that have not been merged to the MergeTargetBranch. Issue IDs are parsed using the IssueIdRegex or the default regex of '(?:#)(\d+)' if no regular expression is specified.
Namespace
NBuildKit.MsBuild.Tasks.VersionControl
Base Types
graph TD Base0["GitCommandLineToolTask"]-->Type click Base0 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/GitCommandLineToolTask" Base1["CommandLineToolTask"]-->Base0 click Base1 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/CommandLineToolTask" Base2["BaseTask"]-->Base1 click Base2 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/BaseTask" Base3["Task"]-->Base2 Type["ExtractIssueIdsFromGitCommitMessages"] class Type type-node

Syntax

public sealed class ExtractIssueIdsFromGitCommitMessages : GitCommandLineToolTask

Constructors

Name Summary
ExtractIssueIdsFromGitCommitMessages() Initializes a new instance of the ExtractIssueIdsFromGitCommitMessages class.
ExtractIssueIdsFromGitCommitMessages(IApplicationInvoker) Initializes a new instance of the ExtractIssueIdsFromGitCommitMessages 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
GitExecutablePath ITaskItem
Gets or sets the path to the GIT command line executable.
Inherited from GitCommandLineToolTask
IssueIdRegex string
Gets or sets the regular expression that is used to extract the issue ID from a GIT commit message. Defaults to '(?:#)(\d+)', i.e. a hash sign followed by a number of digits.
IssueIds ITaskItem[]
Gets or sets the collection containing the issue IDs which were extracted from the set of unmerged commits.
LogEnvironmentVariables bool
Gets or sets a value indicating whether the environment variables for the process should be logged.
Inherited from CommandLineToolTask
MergeTargetBranch string
Gets or sets the name of the branch to which the current set of commits should be merged.
Workspace ITaskItem
Gets or sets the full path to the workspace that contains the .git directory.
Inherited from GitCommandLineToolTask

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
GetGitOutput(IEnumerable<string>) string
Invokes the GIT command line tool with the given arguments in the provided workspace directory.
Inherited from GitCommandLineToolTask
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
InvokeGit(IEnumerable<string>, DataReceivedEventHandler) int
Invokes the GIT command line tool with the given arguments in the provided workspace directory.
Inherited from GitCommandLineToolTask
UpdateEnvironmentVariables(StringDictionary) void
Updates the environment variables for the application prior to execution.
Inherited from CommandLineToolTask
VerbosityForCurrentMsBuildInstance() string
Gets the verbosity that the current MsBuild instance is running at.
Inherited from BaseTask
static