Customizable Release Notes

Build a utility that produces release notes from conventional commits while allowing callers to supply a preset and layer parser/writer overrides on top of that preset.

Capabilities

Generates with preset name and parser override

• With preset "angular" and a parser override that treats DEPRECATION as a note keyword, a commit containing DEPRECATION: drop v1 API in its body appears under the note heading with that body text. @test

Accepts preset config file with writer override

• When given a preset config file path that remaps the chore type to a Maintenance section via writer options, a chore: tidy docs commit appears under a ### Maintenance heading. @test

Defaults when no preset provided

• Without a preset or preset config path, generating notes from feat: add login yields a ### Features heading with a bullet for add login. @test

Surfaces preset load errors

• Supplying an unknown preset name results in a rejected promise or thrown error from the release-notes generation. @test

Implementation

@generates

API

/**
 * Generate release notes from conventional commits using an optional preset or preset config path,
 * allowing parser and writer overrides to merge with the loaded preset options.
 *
 * @param {Object} options
 * @param {Array<{message: string, hash?: string, body?: string}>} options.commits - Conventional commits to include.
 * @param {string} [options.preset] - Name of the conventional-changelog preset to load.
 * @param {string} [options.presetConfigPath] - File path to a preset configuration module to load.
 * @param {Object} [options.parserOverrides] - Parser option overrides applied on top of the preset defaults.
 * @param {Object} [options.writerOverrides] - Writer option overrides applied on top of the preset defaults.
 * @param {Object} [options.context] - Release context (version, previous tag, current tag, repo info).
 * @returns {Promise<string>} Generated release notes text.
 */
export async function buildReleaseNotes(options);

Dependencies { .dependencies }

@semantic-release/release-notes-generator { .dependency }

Produces changelog text from conventional commit data using conventional-changelog presets. @satisfied-by