リリースノートで定義すべきこと
構成・読者別フィルタ・CHANGELOG からの Python 自動生成

# v1.4.0 リリースノート（2026-06-27）

## 🎉 ハイライト

このリリースではダッシュボードへのデータエクスポート機能と
検索パフォーマンスの大幅な改善を提供します。

## ✨ 新機能

- **データエクスポート機能**：ダッシュボードのデータを CSV / Excel 形式でダウンロードできるようになりました。

## 📈 改善

- 検索結果の表示が最大 3 倍速くなりました。
- Safari でのログイン画面の表示崩れを修正しました。

## 🔒 セキュリティ

- セッションの有効期限を短縮しました（セキュリティ強化）。

# v1.4.0 Developer Release Notes（2026-06-27）

## ⚠️ ブレイキングチェンジ

- 検索 API のレスポンスが JSON:API 準拠に変更。`data.results` → `data.items`

## Added
- ダッシュボードに CSV / Excel エクスポートエンドポイント追加（`GET /api/v1/export`）

## Changed
- 検索 API レスポンス形式を JSON:API 準拠に変更（後方互換性なし）

## Deprecated
- `/v1/search` エンドポイントは v2.0.0 で削除予定。`/v2/search` へ移行してください。

## Fixed
- Safari ブラウザでのセッションクッキー処理のバグを修正（#412）

## Security
- JWT 有効期限を 24h → 1h に短縮（セキュリティポリシー変更）
- 影響なし（後方互換あり）

## マイグレーション手順

```diff
- const res = await fetch('/api/v1/search');
- const items = res.data.results;
+ const res = await fetch('/api/v2/search');
+ const items = res.data.items;
```

"""
CHANGELOG.md からリリースノートを自動生成するスクリプト。
--audience dev  : 全セクション出力（開発者向け）
--audience user : Added / Changed のみ出力（エンドユーザー向け）
"""

import argparse
import re
import sys
from pathlib import Path
from dataclasses import dataclass, field

# ユーザー向けに含めるセクション
USER_SECTIONS = {"Added", "Changed"}
ALL_SECTIONS = {"Added", "Changed", "Deprecated", "Removed", "Fixed", "Security"}

VERSION_PATTERN = re.compile(r"^## \[(\d+\.\d+\.\d+[^\]]*)\] - (\d{4}-\d{2}-\d{2})$")
SECTION_PATTERN = re.compile(r"^### (.+)$")

SECTION_EMOJI = {
    "Added": "✨",
    "Changed": "🔄",
    "Deprecated": "⚠️",
    "Removed": "🗑️",
    "Fixed": "🐛",
    "Security": "🔒",
}


@dataclass
class VersionBlock:
    version: str
    date: str
    sections: dict = field(default_factory=dict)  # section_name -> list[str]


def parse_changelog(path: str) -> list[VersionBlock]:
    """CHANGELOG.md をパースしてバージョンブロックのリストを返す"""
    blocks: list[VersionBlock] = []
    current_block: VersionBlock | None = None
    current_section: str | None = None

    for line in Path(path).read_text(encoding="utf-8").splitlines():
        m = VERSION_PATTERN.match(line)
        if m:
            if current_block:
                blocks.append(current_block)
            current_block = VersionBlock(version=m.group(1), date=m.group(2))
            current_section = None
            continue

        if line.startswith("## [Unreleased]"):
            current_block = None
            current_section = None
            continue

        if current_block is None:
            continue

        ms = SECTION_PATTERN.match(line)
        if ms:
            current_section = ms.group(1)
            if current_section not in current_block.sections:
                current_block.sections[current_section] = []
            continue

        if current_section and line.startswith("- "):
            current_block.sections[current_section].append(line)

    if current_block:
        blocks.append(current_block)

    return blocks


def generate_notes(block: VersionBlock, audience: str) -> str:
    """バージョンブロックからリリースノート文字列を生成する"""
    target_sections = USER_SECTIONS if audience == "user" else ALL_SECTIONS
    label = "ユーザー向け" if audience == "user" else "開発者向け"

    lines = [
        f"# v{block.version} リリースノート ({label})",
        f"**リリース日：** {block.date}",
        "",
    ]

    for section in ["Added", "Changed", "Deprecated", "Removed", "Fixed", "Security"]:
        if section not in target_sections:
            continue
        entries = block.sections.get(section, [])
        if not entries:
            continue
        emoji = SECTION_EMOJI.get(section, "")
        lines.append(f"## {emoji} {section}")
        lines.extend(entries)
        lines.append("")

    if not any(
        block.sections.get(s) for s in target_sections
    ):
        lines.append("_このバージョンには該当する変更がありません。_")

    return "\n".join(lines)


def main() -> int:
    parser = argparse.ArgumentParser(
        description="CHANGELOG.md からリリースノートを生成する"
    )
    parser.add_argument("changelog", nargs="?", default="CHANGELOG.md")
    parser.add_argument("--version", default=None, help="対象バージョン（省略時は最新）")
    parser.add_argument(
        "--audience",
        choices=["dev", "user"],
        default="dev",
        help="読者種別（dev: 開発者向け / user: エンドユーザー向け）",
    )
    parser.add_argument("--output", default=None, help="出力ファイルパス（省略時は標準出力）")
    args = parser.parse_args()

    if not Path(args.changelog).exists():
        print(f"❌ ファイルが見つかりません: {args.changelog}")
        return 1

    blocks = parse_changelog(args.changelog)
    if not blocks:
        print("❌ CHANGELOG にバージョンブロックが見つかりません")
        return 1

    target = blocks[0]
    if args.version:
        matches = [b for b in blocks if b.version == args.version]
        if not matches:
            print(f"❌ バージョン {args.version} が見つかりません")
            return 1
        target = matches[0]

    notes = generate_notes(target, args.audience)

    if args.output:
        Path(args.output).write_text(notes, encoding="utf-8")
        print(f"✅ リリースノートを生成しました: {args.output}")
    else:
        print(notes)

    return 0


if __name__ == "__main__":
    sys.exit(main())

# 最新バージョンの開発者向けリリースノートを生成
python generate_release_notes.py CHANGELOG.md --audience dev

# v1.4.0 のユーザー向けリリースノートをファイル出力
python generate_release_notes.py CHANGELOG.md \
  --version 1.4.0 \
  --audience user \
  --output release-notes-1.4.0-user.md

name: Generate Release Notes

on:
  push:
    tags:
      - "v*"

jobs:
  release-notes:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"

      - name: Generate dev release notes
        run: |
          python tools/generate_release_notes.py CHANGELOG.md \
            --audience dev \
            --output dist/release-notes-dev.md

      - name: Generate user release notes
        run: |
          python tools/generate_release_notes.py CHANGELOG.md \
            --audience user \
            --output dist/release-notes-user.md

      - name: Create GitHub Release
        uses: softprops/action-gh-release@v2
        with:
          body_path: dist/release-notes-dev.md
          files: dist/release-notes-*.md