release-notes

Generate release notes from git tags automatically by analyzing commit history and GitHub pull requests to summarize changes, categorize contributions, and identify new contributors in a structured Markdown document.

Categorize GitHub pull requests into sections for a changelog by fetching PR metadata and classifying entries into Breaking Changes, Highlights, Core Library, Docs, and Chores for structured formatting.

You need the gh tool installed to generate release notes from GitHub PRs, as it fetches pull request metadata like titles, labels, bodies, and author information required for the analysis.

Detecting first-time contributors in release notes works by analyzing merged GitHub pull requests within a git tag range and identifying authors who have not previously contributed to the project.

The best way to compare commits between two git tags for release documentation is to parse the commit history and fetch GitHub PR metadata to summarize categorized changes and new contributors.

Limitations when using git tags to generate structured Markdown release notes include relying on consistent PR labeling for accurate categorization and requiring the gh tool for fetching all pull request metadata.