Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KeepAChangelogWriter

Builder for a changelog from conventional commits in keep-a-changelog format.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static Readonly DefaultChangelogFile

DefaultChangelogFile: "CHANGELOG.md" = 'CHANGELOG.md'

Methods

Protected createLatestChangelogStream

getUnreleasedChangelog

Protected mergeWithChangelog

  • mergeWithChangelog(latestChangelogStream: Readable, changelogPath: string, context?: GitRepositoryContext): Promise<Readable>

  • Merges the changelog since the latest release with the main changelog.

    Parameters

    • latestChangelogStream: Readable

      The stream with the changelogs since the latest release.

    • changelogPath: string

      The file path of the changelog to be merged.

    • Optional context: GitRepositoryContext

      The context information of the git repository.

    Returns Promise<Readable>

    The stream of the merged changelog.

write

  • Writes a changelog.

    Parameters

    • context: GitRepositoryContext

      The context information of the git repository.

    • logs: GitLog[]

      The conventional git logs since the last release.

    Returns Promise<void>

Static getLatestChangelogName

  • getLatestChangelogName(changelogFileName: string): string

  • Derives the name of the seperated latest changelog from the main changelog name.

    Parameters

    • changelogFileName: string

      The name of the main changelog.

    Returns string

    The derived name for the latest changelog.