ChangelogWriterOptions

Options of the ChangelogWriter.

Hierarchy

ChangelogWriterOptions
- ConventionalChangelogWriterOptions
- KeepAChangelogWriterOptions

Index

Properties

basePath
changelogFileName
storeLatestChangelog

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 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).