@ncontiero/changelog-github

A custom changelog entry generator for Changesets

Generates GitHub release notes with links to commits, pull requests, and authors, featuring advanced exclusion options and summary overrides.

Getting Started

First, install the package:

npm i --save-dev @ncontiero/changelog-github

Then, add it to your .changeset/config.json:

{
  "changelog": [
    "@ncontiero/changelog-github",
    {
      "repo": "<org>/<repo>"
    }
  ]
}

Configuration

You can customize the generated changelog by providing an exclude object. This is useful if you want to keep your changelogs cleaner by removing pull requests, commits, or author mentions.

{
  "changelog": [
    "@ncontiero/changelog-github",
    {
      "repo": "<org>/<repo>",
      "exclude": {
        "user": true,
        "pr": true,
        "commit": true
      }
    }
  ]
}

Note: All keys inside exclude are optional and default to false.

You can also use the ignoreUsers array to exclude specific usernames from being thanked. This is perfect for single-maintainer packages or bots where you don't need a "Thanks..." message for yourself, but still want to thank external contributors.

{
  "changelog": [
    "@ncontiero/changelog-github",
    {
      "repo": "<org>/<repo>",
      "ignoreUsers": ["your-username", "renovate[bot]"]
    }
  ]
}

Advanced Usage (Overrides)

You can manually override the PR, commit, or user directly from the changeset summary text! Just include them in your changeset markdown:

---
"my-package": patch
---

pr: #42
commit: 7c3aed7
author: @ncontiero

Fixed an annoying bug that crashed the app.

Example Output

By default (without exclusions), a changeset entry will be formatted like this in your CHANGELOG.md:

• #42 7c3aed7 Thanks @ncontiero! - Fixed an annoying bug that crashed the app.