Changelog GitHub

Um gerador de changelog para changeset no GitHub com links para commits, PRs e opcionalmente usuários.

@ncontiero/changelog-github

Um gerador de changelog para changeset no GitHub com links para commits, PRs e opcionalmente usuários.

license mit NPM version

Começando

Primeiro instale o pacote:

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

E use-o em .changeset/config.json:

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

Há também uma opção opcional, que é exclude, um objeto e pode ter as chaves user, pr e commit e seus valores sendo booleanos.

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

Esta opção não adiciona o comentário: "Thanks <@user>!".

E você pode usar para remover os pull releases:

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

E para remover os commits:

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