Repository URL Normalizer

Convert raw repository URLs into a normalized changelog link context that captures host, owner, repository name, and link bases suitable for release note generation.

Capabilities

Normalize HTTPS GitHub URLs

• Given repositoryUrl "https://github.com/acme/release-notes.git", produce host "github.com", owner "acme", repository "release-notes", browseUrl "https://github.com/acme/release-notes", compareUrl "https://github.com/acme/release-notes/compare", commitUrl "https://github.com/acme/release-notes/commit", issueUrl "https://github.com/acme/release-notes/issues", and set both linkCompare and linkReferences to true by default. @test

Accept SSH/scp-style URLs

• Given repositoryUrl "git@github.com:team/service.git", normalize to the same values as "https://github.com/team/service" with an https scheme and no .git suffix. @test

Respect explicit HTTP and link toggles

• Given repositoryUrl "http://github.com/edge/calc" and options { linkCompare: false, linkReferences: false }, preserve the http scheme in all generated URLs and set both toggles to false. @test

Implementation

@generates

API

/**
 * Build a normalized repository context for changelog linking.
 *
 * @param {Object} options
 * @param {string} options.repositoryUrl - Raw repository URL in any supported git format.
 * @param {string} [options.host] - Override for host when not inferable from repositoryUrl.
 * @param {string} [options.commit] - Override commit path segment (e.g., "changeset").
 * @param {string} [options.issue] - Override issue path segment (e.g., "bugs").
 * @param {boolean} [options.linkCompare] - Whether to include compare links in output.
 * @param {boolean} [options.linkReferences] - Whether to hyperlink commit/issue references.
 * @returns {Object} context with normalized fields:
 *   host, owner, repository, browseUrl, compareUrl, commitUrl, issueUrl,
 *   linkCompare, linkReferences.
 */
export function buildRepoContext(options);

Dependencies { .dependencies }

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

Builds repository link context and changelog-friendly URLs from git repo metadata.