GitReleaseNotesAliases.

GitReleaseNotes(ICakeContext, FilePath, GitReleaseNotesSettings) Method

Summary

Generates a set of release notes based on the commit history of the repository and specified settings.
Namespace
Cake.Common.Tools.GitReleaseNotes
Containing Type
GitReleaseNotesAliases

Syntax

[CakeMethodAlias]
[CakeAliasCategory("GitReleaseNotes")]
public static void GitReleaseNotes(this ICakeContext context, FilePath outputFile, GitReleaseNotesSettings settings)

Examples

GitReleaseNotes("c:/temp/releasenotes.md", new GitReleaseNotesSettings {
    WorkingDirectory         = "c:/temp",
    Verbose                  = true,
    IssueTracker             = IssueTracker.GitHub,
    AllTags                  = true,
    RepoUserName             = "bob",
    RepoPassword             = "password",
    RepoUrl                  = "http://myrepo.co.uk",
    RepoBranch               = "master",
    IssueTrackerUrl          = "http://myissuetracker.co.uk",
    IssueTrackerUserName     = "bob",
    IssueTrackerPassword     = "password",
    IssueTrackerProjectId    = "1234",
    Categories               = "Category1",
    Version                  = "1.2.3.4",
    AllLabels                = true
});

Attributes

Type Description
CakeMethodAliasAttribute An attribute used to mark script method aliases.
CakeAliasCategoryAttribute An attribute used for documentation of alias methods/properties.

Parameters

Name Type Description
context ICakeContext The context.
outputFile FilePath The output file.
settings GitReleaseNotesSettings The settings.

Return Value

Type Description
void