Skip to content

Easily generate changelog notes for your project

License

Notifications You must be signed in to change notification settings

riskledger/generate-changelog

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

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