Registry / devops / changesets-format-with-issue-links

changesets-format-with-issue-links

library0.3.0jsnpmunverified

A changelog formatter for @changesets/cli that adds links to git commits, issues, and pull requests. Version 0.3.0, actively maintained, with TypeScript types included. It provides a similar output to standard-version or Release Please, allowing customization of link templates for GitHub, Bitbucket, or other services. It requires @changesets/cli v2+ and integrates into the Changesets config without needing the commit option.

devops

npm install changesets-format-with-issue-links

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · CHANGESETS-FORMAT-

changesets-format-with-issue-links

devopsjavascriptv0.3.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default export (function)

✓ import changesetsFormatWithIssueLinks from 'changesets-format-with-issue-links';

✗ const changesetsFormatWithIssueLinks = require('changesets-format-with-issue-links');

The package exports a default function used as a configuration value in .changeset/config.json. Direct import is rarely needed; it's used as a string reference in config.

getReleaseLine (named export)

✓ import { getReleaseLine } from 'changesets-format-with-issue-links';

If you need to use the formatter programmatically, you can import this named export. It's part of the public API.

getDependencyReleaseLine (named export)

✓ import { getDependencyReleaseLine } from 'changesets-format-with-issue-links';

Another named export for the changelog formatter. Can be used together with getReleaseLine.

Configures the formatter in .changeset/config.json. The changelog option uses two-element array with package name and options. Ensure repoBaseUrl is set.

// Install: npm install --D changesets-format-with-issue-links // .changeset/config.json { "changelog": [ "changesets-format-with-issue-links", { "repoBaseUrl": "https://github.com/your-username/repo", "issueTemplate": " ([#$issue]($repoBaseUrl/issues/$issue))", "commitTemplate": " ([$abbrevHash]($repoBaseUrl/commit/$hash))" } ], "commit": false }

Debug

Known issues

breakingThe package requires @changesets/cli v2 or later. Using with v1 will cause errors.

fix

Update @changesets/cli to ^2.0.0.

affects: >=0.1.0

gotchaWhen using issueTemplate, ensure the regex in issuePattern matches your commit messages exactly. Default is '#(\\d+)\\)' which matches numbers followed by a closing parenthesis.

fix

Adjust issuePattern to match your commit message format (e.g., '#\\d+' without trailing parenthesis).

affects: >=0.1.0

gotchaThe formatter does not work if the commit option is enabled in Changesets config. It uses git log to retrieve commit info, so commit should be set to false.

fix

Set "commit": false in .changeset/config.json.

affects: >=0.1.0

deprecatedIn versions <0.3.0, the option 'baseUrl' was used. It has been renamed to 'repoBaseUrl'.

fix

Use 'repoBaseUrl' in your config object.

affects: <0.3.0

Errors

Common errors & fixes

Cannot find module 'changesets-format-with-issue-links'

Package not installed or peer dependency mismatch.

fix

Run `npm install --D changesets-format-with-issue-links` and ensure @changesets/cli is installed.

Error: The 'repoBaseUrl' option is required

Missing required option in .changeset/config.json.

fix

Add 'repoBaseUrl': 'https://github.com/username/repo' to the changelog options array.

Error: Invalid template string: $issueMatch used without a matching capture group

The issuePattern regex does not contain a capturing group.

fix

Modify issuePattern to include a capturing group, e.g., '#(\\d+)'.

Upgrade

Version history

0.3.0latest on npm

Audit

Dependencies

@changesets/clirequiredPeer dependency required to function as a changelog formatter

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/spautz/changesets-changelog-format ↗

packagechangesets-format-with-issue-links ↗

homepagehttps://github.com/spautz/changesets-changelog-format/packages/changesets-format-with-issue-links#readme ↗