Documentation
README
Release Notes Drafter
Generate clear, user-facing release notes from git log between two refs.
When to fire
- User mentions: "release notes", "changelog", "what shipped", "summarize this milestone"
- A git ref range or version tag is in scope (e.g.
v1.2.0..HEAD,last-tag..main)
Inputs you should gather
- The two refs (default:
<latest tag>..HEADif user didn't specify) - Audience: end users (default), API consumers, internal team
- Output format: markdown (default), JSON, or plain text
Steps
This is the opening of the README. Read the full README on GitHub.