Changelog Generator

A configurable commit-based changelog generator. It finds commits since the previous release, filters them, then groups them.

Generated changelogs look similar to the changelogs generated by GoReleaser, making this action a great fit for projects where another build tool is used.

Usage

GitHub Action

Inputs

Name	Description	Default
output	Generated changelog path.
path	Path to the local git repository	"."
config	Path to the config file.	.changelog-generator.yaml
token	GitHub token used to fetch release assets.	${{ github.token }}
install-only	Installs changelog-generator without running it	"false"

Outputs

Name	Description
changelog	The generated changelog markdown.

Example

name: Release

on:
  push:
    tags:
      - "v*.*.*"

jobs:
  release:
    name: Release
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: Generate Changelog
        uses: gabe565/changelog-generator-action@v1
        id: changelog
      - name: Release
        uses: softprops/action-gh-release@v2
        with:
          body: ${{ steps.changelog.outputs.changelog }}

Configuration

Configuration is loaded from .changelog-generator.yaml in the git repo root. See the config example for more details.

If .changelog-generator.yaml is not found, Changelog Generator will attempt to load the changelog key from .goreleaser.yaml.