GitHub Releases形式
引用スタイルの破壊的変更と比較リンクプレースホルダーを含む、GitHub Releases向けに最適化されたマークダウンを作成します。
Format Types
詳細な説明
GitHub Releasesマークダウン
GitHub Releases形式は、GitHub Releasesページで美しくレンダリングされるマークダウンを生成します。破壊的変更に引用ブロックを使用し、下部に比較リンクを含むなど、GitHub固有のマークダウン機能を活用します。
出力構造
## 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*
他の形式との主な違い
GitHub Releases形式はKeep a Changelogとはいくつかの点で異なります：
- トップレベル見出しなし — GitHubがリリースタイトルを提供するため、形式はバージョンの
##から始まります。 - 破壊的変更の引用ブロック — 通常の見出しではなく、破壊的変更は太字強調付きの引用ブロックで囲まれ、視覚的に目立つコールアウトを作成します。
- 比較リンク — GitHub比較ビューへのプレースホルダーリンクが追加され、読者が完全なdiffを表示しやすくなります。
- 前文なし — GitHub Releasesのコンテキストにより冗長となるKeep a Changelogの仕様テキストは省略されます。
GitHubでのレンダリング
このマークダウンをGitHubの「Describe this release」フィールドに貼り付けると、各見出しはレンダリングビューで折りたたみ可能なセクションになります。引用ブロックは左ボーダー付きでレンダリングされ、破壊的変更に注目を集めます。
ユースケース
GitHubでリリースを公開し、生成されたマークダウンをリリース本文に直接貼り付けたいチームに最適です。比較リンクと引用ブロックの書式はGitHub UIに最適化されています。