duniul / changesets-changelog-clean

A clean changelog entry generator with Github support for `changesets`. 📝

changesets-changelog-clean

A clean changelog entry generator with Github support for changesets. 📝

Drop-in replacement for @changesets/changelog-github.

Usage

// .changeset/config.json

{
  "changelog": ["changesets-changelog-clean", { "repo": "repo-scope/repo-name" }]
  // ...rest of the config
}

Installation

npm install changesets-changelog-clean
# or
pnpm add changesets-changelog-clean
# or
yarn add changesets-changelog-clean

Examples

See examples/example-changelog.md for an example changelog.

Options

The options should be passed as the second argument in the array passed to the changelog key in the changeset config.

  "changelog": ["changesets-changelog-clean", { /* options */ }]

• repo: The Github repo (including scope, like user or org) to link and look up PRs in (like repo-scope/repo-name).
  Required.
• capitalize: Whether to capitalize the first letter of the summary.
  Default: true.
• throwOnGithubError: Whether to throw and stop if there is an error when fetching from Github. Disabling can be useful if you want to generate a changelog for a change that hasn't been merged yet.
  Default: true.

Motivation

The default @changests/changelog-github generator is great, but it can be a bit hard to read.

• It puts the PR and author name in front of the summary, so the summaries don't start on the same column.
• It adds extra text, like the Thanks X, cluttering up the changelog.

I wanted a changelog generator that included the same type of links and information, but in a cleaner format.