GitReleaseNotesSettings Class

Summary

Contains settings used by GitReleaseNotesRunner.
Namespace
Cake.Common.Tools.GitReleaseNotes
Base Types
graph TD Base0["ToolSettings"]-->Type click Base0 "/api/Cake.Core.Tooling/ToolSettings" Base1["object"]-->Base0 Type["GitReleaseNotesSettings"] class Type type-node

Syntax

public sealed class GitReleaseNotesSettings : ToolSettings

Properties

Name Value Summary
AllLabels bool
Gets or sets a value indicating whether all labels should be included in the releasenotes.
AllTags bool
Gets or sets a value indicating whether all tags should be included in the releasenotes.
ArgumentCustomization Func<T, TResult>
Gets or sets the argument customization. Argument customization is a way that lets you add, replace or reuse arguments passed to a tool. This allows you to support new tool arguments, customize arguments or address potential argument issues.
Inherited from ToolSettings
Categories string
Gets or sets a value which allows additional labels to be treated as categories.
EnvironmentVariables IDictionary<TKey, TValue>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
IssueTracker Nullable<T>
Gets or sets the IssueTracker to use.
IssueTrackerFilter string
Gets or sets the Jql query for closed issues you would like included if mentioned.
IssueTrackerPassword string
Gets or sets the password to use when accessing issue tracker.
IssueTrackerProjectId string
Gets or sets the Project Id to use when accessing issue tracker.
IssueTrackerToken string
Gets or sets the token to use when accessing issue tracker.
IssueTrackerUrl string
Gets or sets the Url to the Issue Tracker.
IssueTrackerUserName string
Gets or sets the username to use when accessing issue tracker.
RepoBranch string
Gets or sets the branch name to checkout any existing release notes file.
RepoPassword string
Gets or sets the password to use when accessing repository.
RepoToken string
Gets or sets the token to use when accessing repository.
RepoUrl string
Gets or sets the Url to use when accessing repository.
RepoUserName string
Gets or sets the username to use when accessing repository.
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout Nullable<T>
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
Verbose bool
Gets or sets a value indicating whether verbose logging is used.
Version string
Gets or sets a value which specifies the version to publish.
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

Name Value Summary
Dump<GitReleaseNotesSettings>() string
Get a basic string representation of specified object.
IsIn<GitReleaseNotesSettings>(GitReleaseNotesSettings[]) bool
Checks if the source is contained in a list
NotNull<GitReleaseNotesSettings>(string) void
Throws an exception if the specified parameter's value is null.
NotNull<GitReleaseNotesSettings>(string) void
Throws an exception if the specified parameter's value is null.
ThrowIfNull<GitReleaseNotesSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
ThrowIfNull<GitReleaseNotesSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value