Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeepAChangelogWriterOptions

Options of the KeepAChangelogWriter.

Hierarchy

Index

Properties

Properties

Optional basePath

basePath?: string

Path to the node project folder / git repository.

Optional changelogFileName

changelogFileName?: string

Specifies the name of the changelog.

DEFAULT: CHANGELOG.md

Optional description

description?: string

The description of the changelog.

Optional storeLatestChangelog

storeLatestChangelog?: boolean

Set this flag to keep the changelog of the latest release as changelogFileName.latest.md. This file can be useful for some other tools which processes the release information (ex. gitlab).

Optional title

title?: string

The title of the changelog. DEFAULT: 'Changelog'