Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProjectChangelog

A changelog manager that provides functions for viewing, generating and updating changelogs.

Hierarchy

  • ProjectChangelog

Index

Constructors

Methods

Constructors

constructor

  • Initializes a new instance of this class.

    Parameters

    • Optional options: ProjectConfig

      Options of the git flow node project instance.

    Returns ProjectChangelog

Methods

show

  • show(): Promise<void>

  • Prints the changelog to the console.

    Returns Promise<void>

showUnreleasedChanges

  • showUnreleasedChanges(): Promise<void>

  • Prints the unreleased changes as a changelog to the console.

    Returns Promise<void>

update

  • update(version?: string, name?: string): Promise<void>

  • Updates the changelog with the changes since the last release.

    Parameters

    • Optional version: string

      Version the changelog is created for.

    • Optional name: string

      Name of the release.

    Returns Promise<void>