Skip to content

Generate a changelog

Actions
Wraps lerna-changelog to generate a changelog between two commits or tags
v3
Latest
Star (3)

Generate Changelog

Easily generate changelog notes for your project with this GitHub Action

Usage

Following the lerna-changelog configuration steps, you'll either need to create a file called lerna.json or include in your package.json the following:

{
  "changelog": {
    "labels": {
      "feature": "New Feature",
      "bug": "Bug Fix"
    },
    "repo": "username/repo"
  }
}

Inside your .github/workflows/workflow.yml file:

steps:
  - uses: actions/checkout@v1
  - uses: RiskLedger/generate-changelog@v2
    env:
      GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}

License

The code in this project is released under the MIT.

Credits

  • Inspired by Babel's changelog Github Action

Generate a changelog is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Wraps lerna-changelog to generate a changelog between two commits or tags
v3
Latest

Generate a changelog is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.