1.1.10 • Published 10 months ago

@culur/changesets-changelog-github v1.1.10

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

@culur/changesets-changelog-github

NPM Version NPM Download NPM License

CodeFactor Codecov Build and release

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:

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/bar@1.0.1`](https://github.com/culur/culur/packages/bar)

Preview:

💿 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).

1.1.9

10 months ago

1.1.8

10 months ago

1.1.7

10 months ago

1.1.6

11 months ago

1.1.5

12 months ago

1.1.4

12 months ago

1.1.3

1 year ago

1.1.2

1 year ago

1.1.10

10 months ago

1.1.1

1 year ago

1.1.0

1 year ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago