Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@svitejs/changesets-changelog-github-compact

svitejs76.2kMIT1.2.0TypeScript support: included

a more compact version of the @changesets/changelog-github changelog generator

readme

@svitejs/changesets-changelog-github-compact

a more compact version of the @changesets/changelog-github changelog generator

Installation

pnpm i -D @svitejs/changesets-changelog-github-compact

Usage

set changelog in your .changeset/config.json to

"changelog": ["@svitejs/changesets-changelog-github-compact", { "repo": "org/repo" }]

comparison

changelog-github

  • #PR-ID commit Thanks @user! - some description for a changeset with a PR and commit
  • commit Thanks @user! - some text description some description for a changeset without a PR

changelog-github-compact

  • some description for a changeset with a PR and commit (PR)
  • some description for a changeset without a PR (commit)

additional features

If you use (see #123),(fix #123) or (fixes #123) in a changeset description, the #123will automatically be linkified to the corrosponding issue in your repo

example:

  • some description (fixes #123) cool, huh? (PR)

    License

MIT

changelog

@svitejs/changesets-changelog-github-compact

1.2.0

Minor Changes

  • Use short hash in generated labels for same repo commits (#56)

1.1.0

Minor Changes

  • remove blank line between changelog items (#36)

Patch Changes

  • add index.d.ts to dist and exports map (#33)

1.0.0

Major Changes

  • drop support for node12 (#23)

0.1.1

Patch Changes

  • remove unused dependency @changesets/types (#1)

0.1.0

  • initial release