relizy / generateChangelog

Function: generateChangelog()

generateChangelog(__namedParameters): Promise<string>

Defined in: src/core/changelog.ts:206

Generate the changelog string for a single package.

• Fetches commits internally using changelog: true, so types that only declare a title (e.g. docs: { title: '📖 Documentation' }) are included even though they don't trigger a version bump. Callers must provide pkg.path — pkg.commits is no longer consumed.
• include toggles which sections appear in the output. compareLink and contributors are also skipped when minify is true.
• transformBody is invoked between body rendering and final assembly, used by provider releases to plug an AI rewrite step on the body only.

Parameters

__namedParameters

config

ResolvedRelizyConfig

dryRun

boolean

include?

ChangelogInclude

minify?

boolean

newVersion

string

pkg

{ fromTag?: string; name: string; newVersion?: string; path: string; }

pkg.fromTag?

string

pkg.name

string

pkg.newVersion?

string

pkg.path

string

transformBody?

(body) => string | Promise<string>

Returns

Promise<string>