Auto Release Notes 📝

A GitHub Action that automatically generates beautiful release notes from your git history.

Usage

name: Generate Release Notes
on:
  release:
    types: [published]

jobs:
  release-notes:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      
      - uses: feezy1357/auto-release-notes@v1
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          output-file: RELEASE_NOTES.md

Inputs

Input	Description	Required	Default
github-token	GitHub token	✅	${{ github.token }}
output-file	Output file path	❌	RELEASE_NOTES.md
tag-prefix	Version tag prefix	❌	v

Features

• 📋 Auto-categorizes commits by type
• 🏷️ Generates per-tag release notes
• 🔄 Supports historical tag comparison
• 🆓 Free and open source

Support

If this action helps your workflow, consider supporting the project.