Release Notes Link Controls

Create a utility that produces release notes from conventional commits while allowing callers to control how compare links and reference links are emitted.

Capabilities

Compare link toggle

• With compare links disabled, using repository https://github.com/acme/shop.git, previous tag v1.0.0, current tag v1.1.0, version 1.1.0, commits [{"hash":"a1b2c3d","message":"feat: add login (#15)"}], and reference links still enabled, the generated notes exclude any compare/v1.0.0...v1.1.0 hyperlink but still hyperlink #15 to the repository's issues. @test

Reference link toggle

• With reference links disabled and compare links enabled for the same repository, tags, version, and commits as above, the notes include the compare link for v1.0.0...v1.1.0 but render #15 as plain text with no issue or commit hyperlinks. @test

Custom link keywords

• With repository https://gitlab.com/tools/runner.git, previous tag v3.4.0, current tag v3.5.0, version 3.5.0, commits [{"hash":"9f8e7d6","message":"fix: patch runtime (fixes #22)"}], reference and compare links enabled, and custom link keywords commitKeyword: "changeset" and issueKeyword: "tickets", the notes hyperlink the commit hash using /changeset/9f8e7d6 and the issue reference using /tickets/22 under that repository. @test

Implementation

@generates

API

export interface ReleaseNotesOptions {
  repositoryUrl: string;
  previousTag: string;
  currentTag: string;
  version: string;
  commits: Array<{ hash: string; message: string }>;
  includeCompareLink?: boolean;
  includeReferenceLinks?: boolean;
  commitKeyword?: string;
  issueKeyword?: string;
}

export function buildReleaseNotes(options: ReleaseNotesOptions): Promise<string>;

Dependencies { .dependencies }

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

Generates changelog text from commit history with configurable linking.