https://github.com/duniul/changesets-changelog-clean
A clean changelog entry generator with Github support for changesets. 📝
https://github.com/duniul/changesets-changelog-clean
changelog changesets versioning
Last synced: 6 months ago
JSON representation
A clean changelog entry generator with Github support for changesets. 📝
- Host: GitHub
- URL: https://github.com/duniul/changesets-changelog-clean
- Owner: duniul
- License: mit
- Created: 2023-05-04T14:30:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-04T10:02:30.000Z (almost 2 years ago)
- Last Synced: 2025-07-06T14:48:52.078Z (7 months ago)
- Topics: changelog, changesets, versioning
- Language: TypeScript
- Homepage:
- Size: 83 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# changesets-changelog-clean
[](https://www.npmjs.com/package/changesets-changelog-clean)
A clean changelog entry generator with Github support for [changesets](https://github.com/changesets/changesets). 📝
_Drop-in replacement for `@changesets/changelog-github`._
## Usage
```js
// .changeset/config.json
{
"changelog": ["changesets-changelog-clean", { "repo": "repo-scope/repo-name" }]
// ...rest of the config
}
```
## Installation
```sh
npm install changesets-changelog-clean
# or
pnpm add changesets-changelog-clean
# or
yarn add changesets-changelog-clean
```
## Examples
See [examples/example-changelog.md](./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.
```js
"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.