GitReleaseManager

https://gittools.github.io/GitReleaseManager/
Admin
GitReleaseManager is a tool that automates the creation and publication of release notes by...
Tokens:42,719
Snippets:332
Trust Score:9.7
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Install GitReleaseManager.Tool as a .NET Global Tool

Source: https://gittools.github.io/GitReleaseManager/docs/installation/dotnettool

Installs the GitReleaseManager.Tool package as a .NET Global Tool. Requires .NET Core to be installed on the machine.

```bash
dotnet tool install --global GitReleaseManager.Tool

```

--------------------------------

### Install GitReleaseManager with auto-confirmation

Source: https://gittools.github.io/GitReleaseManager/docs/installation/chocolatey

Installs the portable version of GitReleaseManager while automatically confirming the installation prompt.

```powershell
choco install gitreleasemanager.portable -y
```

--------------------------------

### Install GitReleaseManager via Chocolatey

Source: https://gittools.github.io/GitReleaseManager/docs/installation/chocolatey

Executes the standard installation command for the portable version of GitReleaseManager.

```powershell
choco install gitreleasemanager.portable
```

--------------------------------

### Install GitReleaseManager via NuGet

Source: https://gittools.github.io/GitReleaseManager/docs/installation/nuget

Run this command in the Visual Studio Package Manager Console to install GitReleaseManager as a Solution Level package. The package is added to the solution's packages folder and can be consumed in the build process.

```powershell
Install-Package GitReleaseManager

```

--------------------------------

### Run GitReleaseManager from the command line

Source: https://gittools.github.io/GitReleaseManager/docs/installation/dotnettool

After installation, GitReleaseManager is immediately available on the command line. Invoke it with the dotnet-gitreleasemanager command.

```bash
dotnet-gitreleasemanager

```

--------------------------------

### Verify GitReleaseManager installation

Source: https://gittools.github.io/GitReleaseManager/docs/installation/chocolatey

Commands to verify that GitReleaseManager is available on the command line after installation.

```powershell
gitreleasemanager
```

```powershell
grm
```

--------------------------------

### MainOptions.InitVerb Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/MainOptions/3BAFEE1E

Gets or sets the InitVerb property of type InitSubOptions.

```APIDOC
## MainOptions.InitVerb Property

### Description
Gets or sets the InitVerb property of type InitSubOptions.

### Syntax
```csharp
public InitSubOptions InitVerb { get; set; }
```

### Value
| Type | Description |
|------|-------------|
| InitSubOptions | |

```

--------------------------------

### Add assets to a release with GitReleaseManager addasset and create

Source: https://gittools.github.io/GitReleaseManager/docs/commands/add-assets

Two command-line examples for GitReleaseManager. The first uses the addasset command to attach assets to an existing draft release, while the second uses the create command to create a release and include assets in one step. Both require a GitHub token and specify the tag, owner, repository, and a comma-separated list of asset paths.

```bash
gitreleasemanager.exe addasset -t 0.1.0 -u bob --token fsdfsf67657sdf5s7d5f -r repo -a c:\buildartifacts\setup.exe,c:\buildartifacts\setup.nupkg
```

```bash
gitreleasemanager.exe create --tagName 0.1.0 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo --assets c:\buildartifacts\setup.exe,c:\buildartifacts\setup.nupkg
```

--------------------------------

### ShowConfigVerb Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/MainOptions/0F6B7BFE

Gets or sets the ShowConfigVerb property of type ShowConfigSubOptions.

```APIDOC
## ShowConfigVerb Property

### Description
Gets or sets the ShowConfigVerb property of type ShowConfigSubOptions.

### Syntax
```csharp
public ShowConfigSubOptions ShowConfigVerb { get; set; }
```

### Value
| Type | Description |
| --- | --- |
| ShowConfigSubOptions | |

```

--------------------------------

### Provider Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/BaseVcsOptions/424F9470

Gets or sets the Version Control System provider. The default value is GitHub.

```APIDOC
## Provider Property

### Description
Gets or sets the Version Control System provider. The default value is GitHub.

### Syntax
```csharp
[Option("provider", HelpText = "Version Control System provider", Default = VcsProvider.GitHub)]
public VcsProvider Provider { get; set; }
```

### Attributes
- **Option** - Indicates this property is a command-line option.

### Value
- **VcsProvider** - The Version Control System provider. Possible values include GitHub.
```

--------------------------------

### MainOptions.CreateVerb Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/MainOptions/0B4B53DA

The CreateVerb property of the MainOptions class, which gets or sets the CreateSubOptions.

```APIDOC
## CreateVerb Property

### Description
Gets or sets the CreateSubOptions for the MainOptions class.

### Syntax
```csharp
public CreateSubOptions CreateVerb { get; set; }
```

### Value
- **Type**: CreateSubOptions
- **Description**: The CreateSubOptions associated with this MainOptions instance.
```

--------------------------------

### LogFilePath Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/BaseSubOptions/B448C390

Gets or sets the path to where the log file should be created. If not set, logging defaults to the console.

```APIDOC
## LogFilePath Property

### Description
Gets or sets the path to where the log file should be created. If not set, logging defaults to the console.

### Syntax
```csharp
[Option('l', "logFilePath", HelpText = "Path to where log file should be created. Defaults to logging to console.", Required = false)]
public string LogFilePath { get; set; }
```

### Attributes
- **Option** - Indicates this property is a command-line option.

### Value
- **string** - The path to the log file.
```

--------------------------------

### InputFilePath Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/CreateSubOptions/0AEB1C07

Gets or sets the path to the file to be used as the content of the release notes. This property is optional and cannot be used together with a milestone.

```APIDOC
## InputFilePath Property

### Description
Gets or sets the path to the file to be used as the content of the release notes. This property is optional and cannot be used together with a milestone.

### Namespace
GitReleaseManager.Core.Options

### Containing Type
CreateSubOptions

### Syntax
```csharp
[Option('i', "inputFilePath", HelpText = "The path to the file to be used as the content of the release notes. (Can't be used together with a milestone)", Required = false)]
public string InputFilePath { get; set; }
```

### Attributes
| Type | Description |
|------|-------------|
| Option | |

### Value
| Type | Description |
|------|-------------|
| string | |
```

--------------------------------

### AssetPaths Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/CreateSubOptions/DD834026

Gets or sets the paths to the files to include in the release. This property is optional and can be specified using the 'a' or 'assets' command-line option.

```APIDOC
## AssetPaths Property

### Description
Gets or sets the paths to the files to include in the release. This property is optional and can be specified using the 'a' or 'assets' command-line option.

### Syntax
```csharp
[Option('a', "assets", Separator = ',', HelpText = "Paths to the files to include in the release.", Required = false)]
public IList<string> AssetPaths { get; set; }
```

### Attributes
| Type | Description |
|------|-------------|
| Option | Indicates that this property is a command-line option. |

### Value
| Type | Description |
|------|-------------|
| IList<string> | A list of file paths to include in the release. |
```

--------------------------------

### GitReleaseManager create configuration with footer

Source: https://gittools.github.io/GitReleaseManager/docs/configuration/create-configuration

Configuration for GitReleaseManager to include a footer in release notes. The footer-content uses a {milestone} placeholder that is replaced with the actual milestone number via the milestone-replace-text property. This example is from the Chocolatey GUI project and generates a link to https://chocolatey.org/packages/chocolateyGUI/0.13.1. Note: configuring the footer this way is no longer recommended; use separate template files instead.

```yaml
create:
    include-footer: true
    footer-heading: Where to get it
    footer-content: You can download this release from [chocolatey.org](https://chocolatey.org/packages/chocolateyGUI/{milestone})
    footer-includes-milestone: true
    milestone-replace-text: "{milestone}"

```

--------------------------------

### ConfigurationProvider.Provide(string, IFileSystem)

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Configuration/ConfigurationProvider/5C883BAC

Documentation for the ConfigurationProvider.Provide method, which returns a Config object based on the provided git directory and file system.

```APIDOC
## Provide(string, IFileSystem) Method

### Description
Provides a configuration object based on the specified git directory and file system.

### Method
Provide

### Signature
public static Config Provide(string gitDirectory, IFileSystem fileSystem)

### Parameters
- **gitDirectory** (string) - Required - The git directory path.
- **fileSystem** (IFileSystem) - Required - The file system abstraction to use.

### Return Value
- **Config** - The configuration object.

### Attributes
- **SuppressMessageAttribute** - Suppresses a reliability warning about disposing objects before losing scope.
```

--------------------------------

### WriteSample(string targetDirectory, IFileSystem fileSystem)

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Configuration/ConfigurationProvider/B9909759

Writes a sample configuration file to the specified target directory using the provided file system. This method is static and returns void.

```APIDOC
## WriteSample(string targetDirectory, IFileSystem fileSystem)

### Description
Writes a sample configuration file to the specified target directory using the provided file system.

### Method
WriteSample

### Signature
public static void WriteSample(string targetDirectory, IFileSystem fileSystem)

### Parameters
- **targetDirectory** (string) - The directory where the sample configuration file will be written.
- **fileSystem** (IFileSystem) - The file system abstraction used to perform file operations.

### Return Value
- **void** - This method does not return a value.

### Attributes
- **SuppressMessageAttribute** - Suppresses a code analysis warning about disposing objects multiple times.
```

--------------------------------

### Create release from input file (short and long options)

Source: https://gittools.github.io/GitReleaseManager/docs/commands/create

Creates a release using the contents of the specified file as release notes. Two equivalent commands are shown: one using short flags and one using long flags.

```bash
gitreleasemanager.exe create -i c:\temp\releasenotes.md -n 0.1.0 --token fsdfsf67657sdf5s7d5f -o repoOwner -r repo
```

```bash
gitreleasemanager.exe create --inputFilePath c:\temp\releasenotes.md --name 0.1.0 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo
```

--------------------------------

### Create release from milestone (short and long options)

Source: https://gittools.github.io/GitReleaseManager/docs/commands/create

Creates a release with release notes generated from the specified milestone. Two equivalent commands are shown: one using short flags and one using long flags.

```bash
gitreleasemanager.exe create -m 0.1.0 --token fsdfsf67657sdf5s7d5f -o repoOwner -r repo
```

```bash
gitreleasemanager.exe create --milestone 0.1.0 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo
```

--------------------------------

### ScalarStyle Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Configuration.CommentSerialization/CommentsObjectDescriptor/2C6B3030

Gets the ScalarStyle value for the CommentsObjectDescriptor.

```APIDOC
## ScalarStyle Property

### Description
Gets the ScalarStyle value for the CommentsObjectDescriptor.

### Namespace
GitReleaseManager.Core.Configuration.CommentSerialization

### Containing Type
CommentsObjectDescriptor

### Syntax
```csharp
public ScalarStyle ScalarStyle { get; }
```

### Value
| Type | Description |
|------|-------------|
| ScalarStyle | The ScalarStyle value. |
```

--------------------------------

### PublishVerb Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/MainOptions/154EB8B0

Gets or sets the PublishVerb property of type PublishSubOptions.

```APIDOC
## PublishVerb Property

### Description
Gets or sets the PublishVerb property of type PublishSubOptions.

### Syntax
```csharp
public PublishSubOptions PublishVerb { get; set; }
```

### Value
- **Type**: PublishSubOptions
- **Description**: Not provided in source.
```

--------------------------------

### Export all release notes using short parameters

Source: https://gittools.github.io/GitReleaseManager/docs/commands/export

Exports all release notes for a repository to a Markdown file. Requires a GitHub token, owner, repository, and output file path.

```bash
gitreleasemanager.exe export --token fsdfsf67657sdf5s7d5f -o repoOwner -r repo -f c:\temp\releases.md
```

--------------------------------

### LabelVerb Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/MainOptions/996A35C3

Gets or sets the LabelVerb property of type LabelSubOptions.

```APIDOC
## LabelVerb Property

### Description
Gets or sets the LabelVerb property of type LabelSubOptions.

### Syntax
public LabelSubOptions LabelVerb { get; set; }

### Value
- **Type**: LabelSubOptions

```

--------------------------------

### WriteSample(TextWriter)

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Configuration/ConfigSerializer/1B83BB30

Writes a sample configuration to the specified TextWriter. This method is static and returns void.

```APIDOC
## WriteSample(TextWriter)

### Description
Writes a sample configuration to the specified TextWriter.

### Method
WriteSample

### Signature
public static void WriteSample(TextWriter writer)

### Parameters
- **writer** (TextWriter) - Required - The TextWriter to write the sample configuration to.

### Return Value
- **void** - This method returns no value.

```

--------------------------------

### Show config for current working directory

Source: https://gittools.github.io/GitReleaseManager/docs/commands/show-config

Runs `showconfig` with no parameters to display the configuration for the current directory.

```shell
gitreleasemanager.exe showconfig

```

--------------------------------

### SampleAttribute(object) Constructor

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Attributes/SampleAttribute/77100C38

Initializes a new instance of the SampleAttribute class with the specified object value.

```APIDOC
## SampleAttribute(object) Constructor

### Description
Initializes a new instance of the SampleAttribute class.

### Syntax
```
public SampleAttribute(object value)
```

### Parameters
- **value** (object) - The object value for the attribute.

### Return Value
void
```

--------------------------------

### InvalidIssuesException.Errors Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Exceptions/InvalidIssuesException/57F440B4

Gets or sets the list of error messages associated with the InvalidIssuesException.

```APIDOC
## InvalidIssuesException.Errors Property

### Description
Gets or sets the list of error messages associated with the InvalidIssuesException.

### Namespace
GitReleaseManager.Core.Exceptions

### Containing Type
InvalidIssuesException

### Syntax
csharp
public List<string> Errors { get; set; }


### Value
| Type | Description |
|------|-------------|
| List<string> | The list of error messages. |

```

--------------------------------

### InitSubOptions Class

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/InitSubOptions

Defines the InitSubOptions class that is used to create a sample Yaml configuration file in the root directory.

```APIDOC
## InitSubOptions Class

### Namespace
GitReleaseManager.Core.Options

### Base Types
- object
- BaseSubOptions

### Syntax
```
[Verb("init", HelpText = "Creates a sample Yaml Configuration file in root directory")]
public class InitSubOptions : BaseSubOptions
```

### Attributes
- **Verb** - Specifies the verb "init" with help text.

### Properties
- **Debug** (bool) - Inherited from BaseSubOptions.
- **ExtractTemplates** (bool) - Summary not provided.
- **IsCISystem** (bool) - Inherited from BaseSubOptions.
- **LogFilePath** (string) - Inherited from BaseSubOptions.
- **NoLogo** (bool) - Inherited from BaseSubOptions.
- **TargetDirectory** (string) - Inherited from BaseSubOptions.
- **Verbose** (bool) - Inherited from BaseSubOptions.

```

--------------------------------

### Enable file logging with -l or -logFilePath

Source: https://gittools.github.io/GitReleaseManager/docs/logging/logging

Use the `-l` or `-logFilePath` parameter with the `init` command to write command output to a text file, shown here with the path `c:\temp\log.txt`.

```bash
gitreleasemanager.cli.exe init -l c:\temp\log.txt

gitreleasemanager.cli.exe init -logFilePath c:\temp\log.txt

```

--------------------------------

### SampleAttribute.Value Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Attributes/SampleAttribute/39F82C13

Gets the value of the attribute. The property is read-only with a private setter.

```APIDOC
## SampleAttribute.Value Property

### Description
Gets the value of the attribute. The property is read-only with a private setter.

### Syntax
```csharp
public object Value { get; private set; }
```

### Property Value
- **Type**: object

```

--------------------------------

### Create empty release with --allowEmpty

Source: https://gittools.github.io/GitReleaseManager/docs/commands/create

Creates a release with no release notes. The --allowEmpty flag is required; milestone and input file path are ignored.

```bash
gitreleasemanager.exe create -n 0.1.0 --token fsdfsf67657sdf5s7d5f -o repoOwner -r repo --allowEmpty
```

--------------------------------

### MainOptions.AddAssetVerb Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/MainOptions/C5AE67C1

Gets or sets the AddAssetVerb property of type AddAssetSubOptions in the MainOptions class.

```APIDOC
## MainOptions.AddAssetVerb Property

### Description
Gets or sets the AddAssetVerb property of type AddAssetSubOptions in the MainOptions class.

### Namespace
GitReleaseManager.Core.Options

### Containing Type
MainOptions

### Syntax
```csharp
public AddAssetSubOptions AddAssetVerb { get; set; }
```

### Value
| Type | Description |
| --- | --- |
| AddAssetSubOptions | Gets or sets the AddAssetVerb property. |
```

--------------------------------

### VcsService Constructor

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core/VcsService/4264E63C

Initializes a new instance of the VcsService class with the specified dependencies and configuration.

```APIDOC
## VcsService Constructor

### Description
Initializes a new instance of the VcsService class.

### Syntax
```csharp
public VcsService(IVcsProvider vcsProvider, ILogger logger, IReleaseNotesBuilder releaseNotesBuilder, IReleaseNotesExporter releaseNotesExporter, Config configuration)
```

### Parameters
- **vcsProvider** (IVcsProvider) - The VCS provider.
- **logger** (ILogger) - The logger.
- **releaseNotesBuilder** (IReleaseNotesBuilder) - The release notes builder.
- **releaseNotesExporter** (IReleaseNotesExporter) - The release notes exporter.
- **configuration** (Config) - The configuration.

### Return Value
- **void** - This constructor does not return a value.
```

--------------------------------

### TargetCommitish property syntax

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Model/Release/A832964F

Declares the TargetCommitish property as a public string with get and set accessors.

```csharp
public string TargetCommitish { get; set; }
```

--------------------------------

### Release.Assets Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Model/Release/F1EE2321

Gets or sets the assets associated with a release. The property is of type IReadOnlyList<ReleaseAsset>.

```APIDOC
## Release.Assets Property

### Description
Gets or sets the assets associated with a release.

### Namespace
GitReleaseManager.Core.Model

### Containing Type
Release

### Syntax
```csharp
public IReadOnlyList<ReleaseAsset> Assets { get; set; }
```

### Value
| Type | Description |
| --- | --- |
| IReadOnlyList<ReleaseAsset> | The list of release assets. |

```

--------------------------------

### Create configuration file in current directory

Source: https://gittools.github.io/GitReleaseManager/docs/commands/init

Creates a new GitReleaseManager configuration file in the current working directory.

```bash
gitreleasemanager.exe init
```

--------------------------------

### Release.Body Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Model/Release/338075BB

Gets or sets the body of the release. The property is a public string with a getter and setter.

```APIDOC
## Release.Body Property

### Description
Gets or sets the body of the release. This is a public string property with a getter and setter.

### Namespace
GitReleaseManager.Core.Model

### Containing Type
Release

### Syntax
```csharp
public string Body { get; set; }
```

### Value
| Type | Description |
|------|-------------|
| string |  |
```

--------------------------------

### ExportVerb Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/MainOptions/EFA8DEAD

Gets or sets the ExportSubOptions for the MainOptions class. This property is used to configure export-related options.

```APIDOC
## ExportVerb Property

### Description
Gets or sets the ExportSubOptions for the MainOptions class. This property is used to configure export-related options.

### Syntax
```csharp
public ExportSubOptions ExportVerb { get; set; }
```

### Value
| Type | Description |
|------|-------------|
| ExportSubOptions | The export sub-options. |

```

--------------------------------

### VcsService Constructor Syntax

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core/VcsService/4264E63C

Constructor signature for VcsService, taking dependencies for version control, logging, release notes building and exporting, and configuration.

```csharp
public VcsService(IVcsProvider vcsProvider, ILogger logger, IReleaseNotesBuilder releaseNotesBuilder, IReleaseNotesExporter releaseNotesExporter, Config configuration)
```

--------------------------------

### ExecuteAsync(OpenSubOptions)

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Commands/OpenCommand/AE396AE5

Executes the open command asynchronously with the provided options.

```APIDOC
## ExecuteAsync(OpenSubOptions)

### Description
Executes the open command asynchronously with the provided options.

### Method
ExecuteAsync

### Signature
public Task<int> ExecuteAsync(OpenSubOptions options)

### Parameters
- **options** (OpenSubOptions) - The options for the open command.

### Return Value
- **Task<int>** - A task representing the asynchronous operation, with an integer result.

```

--------------------------------

### Milestone.Description Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Model/Milestone/9F2953AF

Gets or sets the description of a milestone. This property is part of the Milestone model in the GitReleaseManager.Core.Model namespace.

```APIDOC
## Milestone.Description Property

### Description
Gets or sets the description of a milestone.

### Syntax
```csharp
public string Description { get; set; }
```

### Value
| Type | Description |
|------|-------------|
| string | The description of the milestone. |

```

--------------------------------

### CommentsObjectDescriptor.Type Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Configuration.CommentSerialization/CommentsObjectDescriptor/4446A5D1

Gets the type of the comment object descriptor. This property is read-only and returns a Type instance.

```APIDOC
## CommentsObjectDescriptor.Type Property

### Description
Gets the type of the comment object descriptor.

### Syntax
```csharp
public Type Type { get; }
```

### Property Value
Type | Description  
---|---  
Type | The type of the comment object descriptor.

```

--------------------------------

### FileSystem.DirectoryGetFiles(string, string, SearchOption) Method

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Helpers/FileSystem/14942999

Documentation for the FileSystem.DirectoryGetFiles method, which returns an enumerable collection of file names matching a search pattern in a specified directory.

```APIDOC
## FileSystem.DirectoryGetFiles(string, string, SearchOption) Method

### Description
Returns an enumerable collection of file names that match a search pattern in a specified directory, using a value to determine whether to search the current directory and all subdirectories.

### Syntax
```csharp
public IEnumerable<string> DirectoryGetFiles(string directory, string searchPattern, SearchOption searchOption)
```

### Parameters
- **directory** (string) - The directory to search.
- **searchPattern** (string) - The search string to match against the names of files in the directory.
- **searchOption** (SearchOption) - Specifies whether to search the current directory and all subdirectories.

### Return Value
- **IEnumerable<string>** - An enumerable collection of file names that match the search pattern.
```

--------------------------------

### TargetCommitish Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/CreateSubOptions/69A78585

Gets or sets the commit to tag. Can be a branch or SHA. Defaults to the repository's default branch.

```APIDOC
## TargetCommitish Property

### Description
Gets or sets the commit to tag. Can be a branch or SHA. Defaults to the repository's default branch.

### Syntax
```csharp
[Option('c', "targetcommitish", HelpText = "The commit to tag. Can be a branch or SHA. Defaults to repository's default branch.", Required = false)]
public string TargetCommitish { get; set; }
```

### Attributes
- **Option** - Indicates this property is a command-line option.

### Value
- **Type**: string
- **Description**: The commit to tag. Can be a branch or SHA. Defaults to the repository's default branch.
```

--------------------------------

### FileSystem.OpenWrite(string path)

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Helpers/FileSystem/C8379E91

This method opens a file for writing and returns a Stream. It is part of the FileSystem helper class in the GitReleaseManager.Core.Helpers namespace.

```APIDOC
## OpenWrite(string path)

### Description
Opens a file for writing and returns a Stream.

### Method
OpenWrite

### Signature
public Stream OpenWrite(string path)

### Parameters
- **path** (string) - Required - The path of the file to open.

### Return Value
- **Stream** - The stream for writing to the file.
```

--------------------------------

### PublishSubOptions.TagName Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/PublishSubOptions/39905C23

Gets or sets the name of the release. This property is required and is typically the generated SemVer version number.

```APIDOC
## PublishSubOptions.TagName Property

### Description
Gets or sets the name of the release. This property is required and is typically the generated SemVer version number.

### Syntax
```csharp
[Option('t', "tagName", HelpText = "The name of the release (Typically this is the generated SemVer Version Number).", Required = true)]
public string TagName { get; set; }
```

### Attributes
- **Option** - Indicates this property is a command-line option.

### Value
- **Type**: string
- **Description**: The name of the release.
```

--------------------------------

### BaseSubOptions.TargetDirectory Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/BaseSubOptions/5DCBC8FC

Documentation for the TargetDirectory property of the BaseSubOptions class, which is a command-line option.

```APIDOC
## Property: TargetDirectory

### Description
Gets or sets the target directory on which GitReleaseManager should be executed. Defaults to the current directory.

### Syntax
```csharp
[Option('d', "targetDirectory", HelpText = "The directory on which GitReleaseManager should be executed. Defaults to current directory.", Required = false)]
public string TargetDirectory { get; set; }
```

### Attributes
- **Option** - Indicates this property is a command-line option.

### Value
- **Type**: string
- **Description**: The directory path.
```

--------------------------------

### Release.HtmlUrl Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Model/Release/0E2D4C56

Gets or sets the HTML URL of the release. This property is part of the Release model in the GitReleaseManager.Core.Model namespace.

```APIDOC
## Release.HtmlUrl Property

### Description
Gets or sets the HTML URL of the release.

### Namespace
GitReleaseManager.Core.Model

### Containing Type
Release

### Syntax
```csharp
public string HtmlUrl { get; set; }
```

### Value
| Type | Description |
|------|-------------|
| string | The HTML URL of the release. |

```

--------------------------------

### FileSystem.Move(string, string)

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Helpers/FileSystem/EEF8147E

Documentation for the FileSystem.Move method, which moves a file from a source path to a destination path.

```APIDOC
## FileSystem.Move(string, string) Method

### Description
Moves a file from a source path to a destination path.

### Method
Move

### Signature
`public void Move(string source, string destination)`

### Parameters
- **source** (string) - The source file path.
- **destination** (string) - The destination file path.

### Return Value
- **void** - This method does not return a value.
```

--------------------------------

### Release.TargetCommitish Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Model/Release/A832964F

Gets or sets the target commitish for a release. This property is part of the Release model in the GitReleaseManager.Core.Model namespace.

```APIDOC
## Release.TargetCommitish Property

### Description
Gets or sets the target commitish for a release.

### Namespace
GitReleaseManager.Core.Model

### Containing Type
Release

### Syntax
```csharp
public string TargetCommitish { get; set; }
```

### Value
| Type | Description |
|------|-------------|
| string | The target commitish. |
```

--------------------------------

### Publish release with short parameter names

Source: https://gittools.github.io/GitReleaseManager/docs/commands/publish

Publishes a release using the short forms of the parameters: -t for tagName, --token for the access token, -o for owner, and -r for repository.

```bash
gitreleasemanager.exe publish -t 0.1.0 --token fsdfsf67657sdf5s7d5f -o repoOwner -r repo
```

--------------------------------

### Milestone.Url Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Model/Milestone/EA44DF0A

Gets or sets the URL associated with the milestone. This property is part of the Milestone model in the GitReleaseManager.Core.Model namespace.

```APIDOC
## Milestone.Url Property

### Description
Gets or sets the URL associated with the milestone.

### Namespace
GitReleaseManager.Core.Model

### Containing Type
Milestone

### Syntax
```csharp
public string Url { get; set; }
```

### Value
| Type | Description |
|------|-------------|
| string | The URL of the milestone. |

```

--------------------------------

### Task<int> ExecuteAsync(TOptions options)

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Commands/ICommand_1/9307A190

Executes the command asynchronously with the provided options and returns a task that resolves to an integer result.

```APIDOC
## Task<int> ExecuteAsync(TOptions options)

### Description
Executes the command asynchronously with the specified options.

### Method
ExecuteAsync

### Signature
```csharp
Task<int> ExecuteAsync(TOptions options)
```

### Parameters
- **options** (TOptions) - The options for the command.

### Return Value
- **Task<int>** - A task representing the asynchronous operation, with an integer result.
```

--------------------------------

### LabelAlias.Plural Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Configuration/LabelAlias/03AA4415

Gets or sets the plural form of the label alias. This property is part of the LabelAlias configuration class.

```APIDOC
## LabelAlias.Plural Property

### Description
Gets or sets the plural form of the label alias.

### Syntax
```csharp
public string Plural { get; set; }
```

### Value
| Type | Description |
|------|-------------|
| string | The plural label alias. |

```

--------------------------------

### CreateSubOptions Class

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/CreateSubOptions

The CreateSubOptions class defines the options for the 'create' verb, which creates draft release notes from a milestone. It includes properties for specifying the milestone, release name, template, assets, and other settings inherited from base option classes.

```APIDOC
## CreateSubOptions Class

### Description
Represents the options for the 'create' verb, which creates draft release notes from a milestone.

### Namespace
GitReleaseManager.Core.Options

### Base Types
- object
- BaseSubOptions
- BaseVcsOptions

### Syntax

[Verb("create", HelpText = "Creates a draft release notes from a milestone.")]
public class CreateSubOptions : BaseVcsOptions


### Attributes
| Type | Description |
|------|-------------|
| Verb | Indicates this class is a command-line verb. |

### Properties
| Name | Type | Summary |
|------|------|---------|
| AllowEmpty | bool | Gets or sets a value indicating whether to allow empty milestones. |
| AssetPaths | IList<string> | Gets or sets the list of asset paths to include in the release. |
| Debug | bool | (Inherited from BaseSubOptions) Gets or sets a value indicating whether to enable debug output. |
| InputFilePath | string | Gets or sets the input file path. |
| IsCISystem | bool | (Inherited from BaseSubOptions) Gets or sets a value indicating whether running in a CI system. |
| LogFilePath | string | (Inherited from BaseSubOptions) Gets or sets the log file path. |
| Milestone | string | Gets or sets the milestone to create release notes for. |
| Name | string | Gets or sets the name of the release. |
| NoLogo | bool | (Inherited from BaseSubOptions) Gets or sets a value indicating whether to suppress the logo. |
| Prerelease | bool | Gets or sets a value indicating whether the release is a prerelease. |
| Provider | VcsProvider | (Inherited from BaseVcsOptions) Gets or sets the VCS provider. |
| RepositoryName | string | (Inherited from BaseVcsOptions) Gets or sets the repository name. |
| RepositoryOwner | string | (Inherited from BaseVcsOptions) Gets or sets the repository owner. |
| TargetCommitish | string | Gets or sets the target commitish (branch or commit) for the release. |
| TargetDirectory | string | (Inherited from BaseSubOptions) Gets or sets the target directory. |
| Template | string | Gets or sets the template for the release notes. |
| Token | string | (Inherited from BaseVcsOptions) Gets or sets the authentication token. |
| Verbose | bool | (Inherited from BaseSubOptions) Gets or sets a value indicating whether to enable verbose output. |
```

--------------------------------

### ExportSubOptions.TagName Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/ExportSubOptions/6F06FD6E

Gets or sets the name of the release. This is an optional option with the short name 't' and long name 'tagName'.

```APIDOC
## ExportSubOptions.TagName Property

### Description
Gets or sets the name of the release. This is an optional option with the short name 't' and long name 'tagName'.

### Syntax
```csharp
[Option('t', "tagName", HelpText = "The name of the release (Typically this is the generated SemVer Version Number).", Required = false)]
public string TagName { get; set; }
```

### Attributes
- **Option** - Indicates this property is a command-line option.

### Value
- **string** - The name of the release.
```

--------------------------------

### ReleaseAssetUpload.FileName Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Model/ReleaseAssetUpload/25C222BC

Gets or sets the name of the file. The property is of type string and is part of the ReleaseAssetUpload class in the GitReleaseManager.Core.Model namespace.

```APIDOC
## ReleaseAssetUpload.FileName Property

### Description
Gets or sets the name of the file.

### Namespace
GitReleaseManager.Core.Model

### Containing Type
ReleaseAssetUpload

### Syntax
csharp
public string FileName { get; set; }


### Value
| Type | Description |
|------|-------------|
| string | The name of the file. |
```

--------------------------------

### CreateCommand Constructor

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Commands/CreateCommand/6AE9F7F2

Constructor for the CreateCommand class. Initializes a new instance with the provided VCS service and logger dependencies.

```csharp
public CreateCommand(IVcsService vcsService, ILogger logger)
```

--------------------------------

### ExportConfig.RegexText Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Configuration/ExportConfig/91D3022D

Gets or sets the regex text used for export configuration. The property is decorated with Sample and YamlMember attributes.

```APIDOC
## ExportConfig.RegexText Property

### Description
Gets or sets the regex text used for export configuration. The property is decorated with Sample and YamlMember attributes.

### Syntax
```csharp
[Sample("### Where to get it(\\r\\n)*You can .*\\.")]
[YamlMember(Alias = "regex-text")]
public string RegexText { get; set; }
```

### Attributes
- **SampleAttribute** - Description: 
- **YamlMember** - Description: 

### Value
- **string** - Description: 
```

--------------------------------

### Create configuration file in specific directory

Source: https://gittools.github.io/GitReleaseManager/docs/commands/init

Creates a new GitReleaseManager configuration file in a specific directory using either the short or long form of the target directory option.

```bash
gitreleasemanager.exe init -d c:\temp
```

```bash
gitreleasemanager.exe init --targetDirectory c:\temp
```

--------------------------------

### CreateEmptyReleaseAsync(string, string, string, string, bool)

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core/IVcsService/92FB38BE

Asynchronously creates an empty release for the specified repository with the given parameters.

```APIDOC
## CreateEmptyReleaseAsync(string, string, string, string, bool)

### Description
Asynchronously creates an empty release for the specified repository with the given parameters.

### Method
CreateEmptyReleaseAsync

### Syntax
```
Task<Release> CreateEmptyReleaseAsync(string owner, string repository, string name, string targetCommitish, bool prerelease)
```

### Parameters
- **owner** (string) - Description not provided.
- **repository** (string) - Description not provided.
- **name** (string) - Description not provided.
- **targetCommitish** (string) - Description not provided.
- **prerelease** (bool) - Description not provided.

### Return Value
- **Task<Release>** - Description not provided.
```

--------------------------------

### Label command with shorthand flags

Source: https://gittools.github.io/GitReleaseManager/docs/commands/label

Uses shorthand flags -o and -r for owner and repository. Requires a GitHub access token.

```bash
gitreleasemanager.exe label --token fsdfsf67657sdf5s7d5f -o repoOwner -r repo
```

--------------------------------

### Milestone Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/CreateSubOptions/A07C7255

Gets or sets the milestone to use for the release. This property is optional and cannot be used together with a release notes file path.

```APIDOC
## Milestone Property

### Description
Gets or sets the milestone to use for the release. This property is optional and cannot be used together with a release notes file path.

### Syntax
```csharp
[Option('m', "milestone", HelpText = "The milestone to use. (Can't be used together with a release notes file path).", Required = false)]
public string Milestone { get; set; }
```

### Attributes
- **Option** - Indicates this property is a command-line option.

### Value
- **Type**: string - The milestone name or identifier.
```

--------------------------------

### Export all release notes using long parameters

Source: https://gittools.github.io/GitReleaseManager/docs/commands/export

Exports all release notes for a repository to a Markdown file using the long form of the parameters.

```bash
gitreleasemanager.exe export --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo --fileOutputPath c:\temp\releases.md
```

--------------------------------

### FileOutputPath Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/ExportSubOptions/46800C93

Gets or sets the file output path for exporting releases. This property is required and is configured via the 'f' or 'fileOutputPath' option.

```APIDOC
## FileOutputPath Property

### Description
Gets or sets the file output path for exporting releases. This property is required and is configured via the 'f' or 'fileOutputPath' option.

### Namespace
GitReleaseManager.Core.Options

### Containing Type
ExportSubOptions

### Syntax
```csharp
[Option('f', "fileOutputPath", HelpText = "Path to the file export releases.", Required = true)]
public string FileOutputPath { get; set; }
```

### Attributes
| Type | Description |
|------|-------------|
| Option | Indicates that this property is a command-line option. |

### Value
| Type | Description |
|------|-------------|
| string | The file output path. |
```

--------------------------------

### BaseSubOptions.IsCISystem Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/BaseSubOptions/A7844613

Documentation for the IsCISystem property of the BaseSubOptions class, which is a command-line option for configuring CI system compatibility.

```APIDOC
## Property: IsCISystem

### Description
Gets or sets a value indicating whether GitReleaseManager should be configured to be compatible with CI systems.

### Syntax
```csharp
[Option("ci", HelpText = "Configure GitReleaseManager to be compatible with CI systems")]
public bool IsCISystem { get; set; }
```

### Attributes
- **Option** - Indicates this property is a command-line option.

### Value
- **bool** - The value indicating CI system compatibility.
```

--------------------------------

### OpenSubOptions Class

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/OpenSubOptions

The OpenSubOptions class defines the options for the 'open' verb, which opens a milestone. It includes properties for specifying the milestone, repository details, and common options.

```APIDOC
## OpenSubOptions Class

### Description
Represents the options for the 'open' verb, which opens a milestone.

### Syntax
csharp
[Verb("open", HelpText = "Opens the milestone.")]
public class OpenSubOptions : BaseVcsOptions


### Namespace
`GitReleaseManager.Core.Options`

### Base Types
- `object`
- `BaseSubOptions`
- `BaseVcsOptions`

### Attributes
- `Verb` - Specifies the verb name and help text.

### Properties
| Name | Type | Summary |
|------|------|---------|
| Debug | bool | Inherited from BaseSubOptions |
| IsCISystem | bool | Inherited from BaseSubOptions |
| LogFilePath | string | Inherited from BaseSubOptions |
| Milestone | string | The milestone to open. |
| NoLogo | bool | Inherited from BaseSubOptions |
| Provider | VcsProvider | Inherited from BaseVcsOptions |
| RepositoryName | string | Inherited from BaseVcsOptions |
| RepositoryOwner | string | Inherited from BaseVcsOptions |
| TargetDirectory | string | Inherited from BaseSubOptions |
| Token | string | Inherited from BaseVcsOptions |
| Verbose | bool | Inherited from BaseSubOptions |
```

--------------------------------

### RawData Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Model/ReleaseAssetUpload/68B04536

Gets or sets the raw data for a release asset upload. The property is of type Stream and is publicly accessible with both getter and setter.

```APIDOC
## RawData Property

### Description
Gets or sets the raw data.

### Namespace
GitReleaseManager.Core.Model

### Containing Type
ReleaseAssetUpload

### Syntax
```csharp
public Stream RawData { get; set; }
```

### Value
| Type | Description |
|------|-------------|
| Stream | The raw data. |
```

--------------------------------

### InvalidIssuesException.Errors property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Exceptions/InvalidIssuesException/57F440B4

Gets or sets the list of error messages associated with the invalid issues. This property is part of the InvalidIssuesException class in the GitReleaseManager.Core.Exceptions namespace.

```csharp
public List<string> Errors { get; set; }
```

--------------------------------

### WriteAllText(string, string)

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Helpers/FileSystem/D0505009

Documentation for the FileSystem.WriteAllText method, which writes text content to a file.

```APIDOC
## WriteAllText(string, string) Method

### Description
Writes the specified text content to a file at the given path.

### Syntax
```csharp
public void WriteAllText(string file, string fileContents)
```

### Parameters
- **file** (string) - The path of the file to write to.
- **fileContents** (string) - The text content to write to the file.

### Return Value
- **void** - This method does not return a value.
```

--------------------------------

### IsMultilineRegex Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Configuration/ExportConfig/2CB5AA5A

Gets or sets a boolean value indicating whether multiline regex is enabled. This property is mapped to the YAML alias 'multiline-regex'.

```APIDOC
## IsMultilineRegex Property

### Description
Gets or sets a boolean value indicating whether multiline regex is enabled. This property is mapped to the YAML alias 'multiline-regex'.

### Syntax
```csharp
[YamlMember(Alias = "multiline-regex")]
public bool IsMultilineRegex { get; set; }
```

### Attributes
- **YamlMember** - Description: 

### Value
- **bool** - Description: 
```

--------------------------------

### CreateSubOptions.Name Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/CreateSubOptions/E46AA0D9

Documentation for the Name property of the CreateSubOptions class, which is a command-line option for specifying the release name.

```APIDOC
## Name Property

### Description
Gets or sets the name of the release, typically the generated SemVer version number.

### Syntax
```csharp
[Option('n', "name", HelpText = "The name of the release (Typically this is the generated SemVer Version Number).", Required = false)]
public string Name { get; set; }
```

### Attributes
- **Option** - Indicates this property is a command-line option.

### Value
- **Type**: string
- **Description**: The name of the release.
```

--------------------------------

### TestContext Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.IntegrationTests/ReleaseNotesBuilderIntegrationTests/1AAFD4DC

Gets or sets the TestContext property for the ReleaseNotesBuilderIntegrationTests class. This property is likely used to access test context information during integration tests.

```APIDOC
## TestContext Property

### Description
Gets or sets the TestContext property for the ReleaseNotesBuilderIntegrationTests class.

### Syntax
```csharp
public TestContext TestContext { get; set; }
```

### Value
| Type | Description |
|------|-------------|
| TestContext | The test context instance. |

```

--------------------------------

### GitLabProvider Constructor

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Provider/GitLabProvider/6C27C534

Constructor for the GitLabProvider class. It takes an IGitLabClient, IMapper, and ILogger as parameters. The return type is void.

```csharp
public GitLabProvider(IGitLabClient gitLabClient, IMapper mapper, ILogger logger)
```

--------------------------------

### CloseSubOptions.Milestone Property

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Options/CloseSubOptions/59FD2A5A

Gets or sets the milestone to use. This property is required and is configured as a command-line option with the short name 'm' and long name 'milestone'.

```APIDOC
## CloseSubOptions.Milestone Property

### Description
Gets or sets the milestone to use. This property is required and is configured as a command-line option with the short name 'm' and long name 'milestone'.

### Syntax
csharp
[Option('m', "milestone", HelpText = "The milestone to use.", Required = true)]
public string Milestone { get; set; }


### Attributes
- **Option** - Indicates this property is a command-line option.

### Value
- **Type**: string - The milestone value.

```

--------------------------------

### OpenWrite(string) Method

Source: https://gittools.github.io/GitReleaseManager/api/GitReleaseManager.Core.Helpers/IFileSystem/0B0C1A8C

Documentation for the OpenWrite method of the IFileSystem interface.

```APIDOC
## OpenWrite(string) Method

### Description
Opens a file for writing and returns a Stream.

### Method
OpenWrite

### Signature
Stream OpenWrite(string path)

### Parameters
#### Parameters
- **path** (string) - Description not provided.

### Return Value
- **Stream** - Description not provided.
```
Tokens:
Raw