@mheob/changeset-changelog


Add my own style for the changelogs generated by the awesome changesets library. The
style was inspired by the original
@changesets/changelog-github and the
@svitejs/changesets-changelog-github-compact packages.

Installation

$3

``sh
npm install -D @mheob/changeset-changelog
`

$3

`sh
yarn add -D @mheob/changeset-changelog
`

$3

`sh
pnpm add -D @mheob/changeset-changelog
`

Usage

Set in your .changeset/config.json file the following snippet:

`jsonc
{
"changelog": ["@mheob/changeset-changelog", { "repo": "YOUR_ORG_OR_USER/YOUR_REPO" }],
}
`

$3

There are differences between this changelog output and the others:

$3

- #PR-ID commit Thanks @user! - Add nice feature to the project with a PR and commit
- commit Thanks @user! - Add nice feature to the project without a PR

$3

- Add nice feature to the project with a PR and commit (#PR)
- Add nice feature to the project without a PR (commit)

$3

- PR (@user): Add nice feature to the project with a PR and commit
- commit (@user): Add nice feature to the project without a PR

Additional feature: linking issues

_Thanks to @svitejs/changesets-changelog-github-compact for this nice feature!_

All links to issues (or pull requests) in the chageset will automatically converted to a link.\
To enable the changeset have to called it like this variants:

- (fix: #123),
- (fixes: #123),
- (resolves: #123) or
- (see: #123)

$3

The changeset

`yml
---
'@mheob/changeset-changelog': patch
---
Add nice feature to the project (see #123)
``

will outputted in the changelog like

> #130 (@user): Add nice Feature to the project, (see #123)