GitHub Releases Format

GitHub Releases Markdown

The GitHub Releases format generates markdown that renders beautifully on the GitHub Releases page. It uses GitHub-flavored markdown features like blockquotes for breaking changes and includes a compare link at the bottom.

Output Structure

## 1.2.0

> **BREAKING CHANGES**
> - **api:** change response format for /users endpoint

### Features
- **auth:** add OAuth2 login with Google
- add dark mode toggle to settings page

### Bug Fixes
- **auth:** resolve token refresh race condition

---
*Full Changelog: https://github.com/your-org/your-repo/compare/v1.2.0...HEAD*

Key Differences from Other Formats

The GitHub Releases format differs from Keep a Changelog in several ways:

1. No top-level heading — GitHub already provides the release title, so the format starts with a ## for the version.
2. Blockquote for breaking changes — Rather than a plain heading, breaking changes are wrapped in a blockquote with bold emphasis, creating a visually prominent callout.
3. Compare link — A placeholder link to the GitHub compare view is appended, making it easy for readers to view the full diff.
4. No preamble — The specification text from Keep a Changelog is omitted since the GitHub Releases context makes it redundant.

Rendering on GitHub

When you paste this markdown into the "Describe this release" field on GitHub, each heading becomes a collapsible section in the rendered view. The blockquote renders with a left border, drawing attention to breaking changes.