Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ConventionalChangelogWriterOptions

Options of the ConventionalChangelogBuilder.

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 conventionalChangelogPresent

conventionalChangelogPresent?: string

Specifies the conventional commit format. The selectable options are:

  • angular (default)
  • atom
  • ember
  • eslint
  • jquery
  • jshint

For more infomation check out the documentation of the conventional-changelog-preset-loader. This loader is used to load the corresponding present.

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