class ChangelogGenerator

ChangelogGenerator - CHANGELOG.md management with PR awareness

Constructors

new
ChangelogGenerator(config: NagareConfig)

Properties

private
logger: Logger
private
prDetector: PRDetector

Methods

private
createChangelogHeader(): string

Create changelog header

private
generatePRChangelogEntry(releaseNotes: PRReleaseNotes): Promise<string>

Generate PR-aware changelog entry using Vento template

private
generatePRGroupedReleaseNotes(
version: string,
date: string,
prResult: PRDetectionResult,
): PRReleaseNotes

Generate PR-grouped release notes

generatePRReleaseNotes(
version: string,
commits: ConventionalCommit[],
): Promise<PRReleaseNotes>

Generate release notes with PR detection

private
generateTraditionalChangelogEntry(releaseNotes: ReleaseNotes): string

Generate traditional changelog entry (backward compatible)

private
generateTraditionalReleaseNotes(
version: string,
date: string,
commits: ConventionalCommit[],
): PRReleaseNotes

Generate traditional release notes (backward compatibility)

private
getBuiltInPRTemplate(): string

Get built-in PR changelog template

private
insertNewEntry(
existingContent: string,
newEntry: string,
): string

Insert new entry into existing changelog

updateChangelog(releaseNotes: ReleaseNotes | PRReleaseNotes): Promise<void>

Update CHANGELOG.md with new release notes

Usage

import { ChangelogGenerator } from ".";