@culur/changesets-changelog-github

A changelog entry generator for GitHub that links to commits, PRs, and users.

✨ Features

This is a changelog entry generator for Github used in Changesets. It's basically @changesets/changelog-github, but the format has been modified and has some more customization:

• Customize message format.
• Add emoji based on conventional commit.

Below are some examples:

1. Changeset with multiple lines

Changeset file:

---
'@culur/foo': patch
---

Feat: add some features:

- Feature A.
- Feature B.

Commit message: feat(foo): add some feature

Generated changelog:

# @culur/foo

## 1.0.1

### Patch Changes

- ✨ Feat: add some features ([#123](https://github.com/culur/culur/pull/123) [`abcd123`](https://github.com/culur/culur/commit/abcd123)) ([@culur](https://github.com/culur)):
  - Feature A.
  - Feature B.

Preview:

• ✨ Feat: add some features (#123 abcd123) (@culur):
  • Feature A.
  • Feature B.

2. Changeset with dependencies updating

Package @culur/bar has been updated to 1.0.1.

Generated changelog:

# @culur/foo

## 1.0.1

### Patch Changes

- 📦 Update workspace dependencies:
  - [`@culur/[email protected]`](https://github.com/culur/culur/packages/bar)

Preview:

• 📦 Update workspace dependencies:
  • @culur/[email protected]

💿 Installation

Add @culur/changesets-changelog-github dependency to your project.

# Using npm
npm install @culur/changesets-changelog-github --save-dev

# Using pnpm
pnpm install @culur/changesets-changelog-github --dev

# Using yarn
yarn add @culur/changesets-changelog-github --dev

📖 Usage

Update your .changesets/config.json:

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

🗃️ Changelog

See CHANGELOG for more information on what has changed recently.

🔒 License

See LICENSE for license rights and limitations (MIT).