Custom Release Notes Generator

Build a helper that produces release notes from conventional commits using preset-configured sections plus parser and writer overrides.

Capabilities

Maps commit types via preset config

• With the section map feat -> Features, fix -> Bug Fixes, and perf -> Performance Improvements, generated notes group commits under those headings while omitting commits whose types are not mapped. @test

Parses bracketed types via parser overrides

• Commits written as "[Perf] Trim startup costs" are parsed so they appear under the "Performance Improvements" section instead of being skipped. @test

Writer overrides control order and empty sections

• Release notes list sections in the order: Performance Improvements, Features, Bug Fixes, and do not render empty sections such as chores when no commits map to them. @test

Implementation

@generates

API

/**
 * Generate release notes with custom sections.
 * @param {Array<{message: string, hash?: string}>} commits - Conventional commit messages.
 * @param {{
 *   presetConfig: { types: Array<{ type: string, section: string }> },
 *   parserOverrides?: object,
 *   writerOverrides?: object,
 *   context: {
 *     repositoryUrl: string,
 *     nextRelease: { version: string, gitTag: string, gitHead?: string },
 *     lastRelease?: { gitTag?: string, gitHead?: string }
 *   }
 * }} options
 * @returns {Promise<string>} Markdown release notes honoring the preset, parser, and writer overrides.
 */
export async function generateReleaseNotes(commits, options);

Dependencies { .dependencies }

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

Generates release notes from conventional commits with customizable preset, parser, and writer options.