Host-Aware Release Notes

A generator that renders release notes from commit history while honoring host-specific link conventions for issues and commits, with optional overrides.

Capabilities

GitHub-style defaults

• With a repository URL on GitHub and commit messages referencing #42 and gh-99, release notes hyperlink those references to the repository's issues path, link commit hashes via the commit path, and include a compare link between previous and next tags when both tags exist. @test

Bitbucket mapping

• For a repository URL on Bitbucket with no overrides, release notes hyperlink issue references using the issue path and commit hashes via the commits path, and leave prefixes unsupported by that host (for example, gh-7) as plain text. @test

Custom host overrides

• When provided a custom host base URL and link keywords, release notes use those overrides instead of host defaults for issue and commit hyperlinks while still parsing commit messages for references. @test

Reference toggles

• When compare or reference linking is disabled, release notes omit the compare section and remove issue/commit hyperlinks while still listing commit messages. @test

Implementation

@generates

API

export interface ReleaseNotesInput {
  /**
   * Git repository URL.
   */
  repoUrl: string;
  /**
   * Commits to include with message and hash.
   */
  commits: Array<{ message: string; hash: string }>;
  /**
   * Previous release metadata, optional.
   */
  lastRelease?: { gitTag?: string; gitHead?: string };
  /**
   * Upcoming release metadata with version and tag/head.
   */
  nextRelease: { version: string; gitTag?: string; gitHead?: string };
  /**
   * Optional overrides for host-aware linking.
   */
  linkOptions?: {
    host?: string;
    issueKeyword?: string;
    commitKeyword?: string;
    enableCompare?: boolean;
    enableReferences?: boolean;
  };
  /**
   * Optional working directory for package data lookup.
   */
  cwd?: string;
}

/**
 * Generate release notes string with host-aware issue/commit links.
 */
export function buildReleaseNotes(input: ReleaseNotesInput): Promise<string>;

Dependencies { .dependencies }

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

Generates release notes using host-aware issue/commit link defaults with optional overrides.

@satisfied-by