genereleaselog

🎨 Generate the Release log in accordance with the GitHub Conventional Commits

Quick Start

Generate a release changelog:

npx genereleaselog --token=GITHUB_TOKEN

Arguments:

• --from: Start commit reference. When not provided, latest git tag will be used as default.
• --to: End commit reference. When not provided, latest commit in HEAD will be used as default.

Example Workflow: .github/workflows/release.yml

name: Release

permissions:
  contents: write

on:
  push:
    tags:
      - 'v*'

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - uses: actions/setup-node@v4
        with:
          node-version: lts/*

      - run: npx genereleaselog
        env:
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

🤝 How to Contribute

We welcome contributions of all kinds! Whether it's fixing a typo in the documentation, improving the code, or suggesting new features.

Contribution Process

• Fork this repository
• Create a new branch (git checkout -b feature/your-feature)
• Commit your changes (git commit -m 'feat: add some feature')
• Push to the branch (git push origin feature/your-feature)
• Open a Pull Request

License

Made with 💛

Published under MIT License.