Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mheob/changeset-changelog
My own style for the changelogs generated by the changesets package
https://github.com/mheob/changeset-changelog
hacktoberfest
Last synced: 1 day ago
JSON representation
My own style for the changelogs generated by the changesets package
- Host: GitHub
- URL: https://github.com/mheob/changeset-changelog
- Owner: mheob
- License: mit
- Created: 2022-10-10T16:53:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-09T14:27:35.000Z (6 days ago)
- Last Synced: 2025-01-09T15:36:25.956Z (6 days ago)
- Topics: hacktoberfest
- Language: TypeScript
- Homepage:
- Size: 688 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# `@mheob/changeset-changelog`
[](https://github.com/mheob/changeset-changelog/actions/workflows/release.yml)
[](https://github.com/mheob/changeset-changelog/actions/workflows/check.yml)
[](https://codecov.io/gh/mheob/changeset-changelog)
Add my own style for the changelogs generated by the awesome [changesets](https://github.com/changesets/changesets) library. The
style was inspired by the original
[@changesets/changelog-github](https://github.com/changesets/changesets/tree/main/packages/changelog-github) and the
[@svitejs/changesets-changelog-github-compact](https://github.com/svitejs/changesets-changelog-github-compact) packages.
## Installation
### With NPM
```sh
npm install -D @mheob/changeset-changelog
```
### With YARN
```sh
yarn add -D @mheob/changeset-changelog
```
### With PNPM
```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" }]
```
### Output
There are differences between this changelog output and the others:
### `@changesets/changelog-github`
- [#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
### `@svitejs/changesets-changelog-github-compact`
- Add nice feature to the project with a PR and commit ([#PR](#))
- Add nice feature to the project without a PR ([commit](#))
### `@mheob/changeset-changelog`
- [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)`
### Example
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](#))