@dkshs/changelog-github

A changelog entry generator for changeset on GitHub with links to commits, PRs, and optionally users.

Getting Started

First Install the package:

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

And use it on .changeset/config.json:

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

There is also an optional option, which is exclude, an object and can have the user,pr and commit keys and their values being boolean.

{
  // ...
  "changelog": [
    "@dkshs/changelog-github",
    {
      "repo": "<org>/<repo>",
      "exclude": { "user": true }
    }
  ]
  // ...
}

This option does not add the comment: "Thanks <@user>!".

And you can use to remove the pull releases:

{
  // ...
  "changelog": [
    "@dkshs/changelog-github",
    {
      "repo": "<org>/<repo>",
      "exclude": { "pr": true }
    }
  ]
  // ...
}

And to remove the commits:

{
  // ...
  "changelog": [
    "@dkshs/changelog-github",
    {
      "repo": "<org>/<repo>",
      "exclude": { "commit": true }
    }
  ]
  // ...
}