Class ChangelogWriter Abstract

Builder for a changelog.

Hierarchy

ChangelogWriter
- ConventionalChangelogWriter
- KeepAChangelogWriter

Index

Constructors

constructor

Properties

DefaultChangelogFile

Methods

Constructors

constructor

new ChangelogWriter(options: ChangelogWriterOptions): ChangelogWriter

Initializes a new instance of this class.

Parameters
- options: ChangelogWriterOptions
  
  The options of the instance.
Returns ChangelogWriter

Properties

Static Readonly DefaultChangelogFile

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

Methods

Protected Abstract createLatestChangelogStream

createLatestChangelogStream(context: GitRepositoryContext, logs: GitLog[]): Promise<Readable>

Creates a changelog stream from the commits since the last release.

Parameters
- context: GitRepositoryContext
  
  The context information of the git repository.
- logs: GitLog[]
  
  The conventional git logs since the last release.
Returns Promise<Readable>

getUnreleasedChangelog

getUnreleasedChangelog(context: GitRepositoryContext, logs: GitLog[]): Promise<string>

Gets the unreleased changes as changelog.

Parameters
- context: GitRepositoryContext
  
  The context information of the git repository.
- logs: GitLog[]
  
  The conventional git logs since the last release.
Returns Promise<string>
A changelog with unreleased changes.

Protected Abstract mergeWithChangelog

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

Merges a changelog stream from the commits since the last release.

Parameters
- latestChangelogStream: Readable
- changelogPath: string
- Optional context: GitRepositoryContext
  
  The context information of the git repository.
Returns Promise<Readable>

write

write(context: GitRepositoryContext, logs: GitLog[]): Promise<void>

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.