CHANGELOG で定義すべきこと
リリース時の構成・SemVer・Python によるフォーマット検証

# Changelog

すべての注目すべき変更はこのファイルに記録されます。
このフォーマットは [Keep a Changelog](https://keepachangelog.com/ja/1.1.0/) に基づいており、
このプロジェクトは [Semantic Versioning](https://semver.org/lang/ja/) に準拠しています。

## [Unreleased]

### Added
- ユーザーダッシュボードにエクスポート機能を追加（CSV / Excel）

---

## [1.4.0] - 2026-06-27

### Added
- ユーザーダッシュボードにエクスポート機能を追加

### Changed
- 検索 API のレスポンス形式を JSON:API 準拠に変更

### Deprecated
- `/v1/search` エンドポイントは v2.0 で削除予定

### Fixed
- Safari でログインが失敗するバグを修正 (#412)

### Security
- JWT の有効期限を 24h → 1h に短縮

---

## [1.3.2] - 2026-05-15

### Fixed
- ページネーションが最終ページで無限ループする問題を修正 (#398)

### Security
- log4j を 2.17.2 へ更新（CVE-2021-44228 対応）

---

## [1.3.1] - 2026-04-03

### Fixed
- タイムゾーンオフセットが考慮されない日付表示のバグを修正

"""
CHANGELOG フォーマット検証スクリプト
Keep a Changelog 形式への準拠を自動チェックする。
"""

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

VALID_SECTIONS = {"Added", "Changed", "Deprecated", "Removed", "Fixed", "Security"}
VERSION_PATTERN = re.compile(r"^## \[(\d+\.\d+\.\d+[^\]]*)\] - (\d{4}-\d{2}-\d{2})$")
UNRELEASED_PATTERN = re.compile(r"^## \[Unreleased\]$")
SECTION_PATTERN = re.compile(r"^### (.+)$")


@dataclass
class ValidationResult:
    errors: list[str] = field(default_factory=list)
    warnings: list[str] = field(default_factory=list)

    @property
    def is_valid(self) -> bool:
        return len(self.errors) == 0

    def report(self) -> None:
        if self.errors:
            print("❌ エラー:")
            for e in self.errors:
                print(f"  - {e}")
        if self.warnings:
            print("⚠️  警告:")
            for w in self.warnings:
                print(f"  - {w}")
        if self.is_valid:
            print("✅ CHANGELOG の検証に成功しました")


def validate_changelog(path: str = "CHANGELOG.md") -> ValidationResult:
    result = ValidationResult()
    content = Path(path).read_text(encoding="utf-8")
    lines = content.splitlines()

    versions_found: list[str] = []
    current_sections: list[str] = []
    in_version_block = False

    for i, line in enumerate(lines, start=1):
        if line.startswith("## "):
            if in_version_block and not current_sections:
                result.warnings.append(
                    f"バージョンブロックにセクションがありません（行 {i} 付近）"
                )
            current_sections = []
            in_version_block = False

            if UNRELEASED_PATTERN.match(line):
                in_version_block = True
                continue

            m = VERSION_PATTERN.match(line)
            if not m:
                result.errors.append(
                    f"行 {i}: バージョンヘッダーの形式が不正です: `{line}`\n"
                    f"  期待形式: `## [X.Y.Z] - YYYY-MM-DD`"
                )
                continue

            version = m.group(1)
            if version in versions_found:
                result.errors.append(f"バージョン {version} が重複しています")
            versions_found.append(version)
            in_version_block = True

        elif line.startswith("### ") and in_version_block:
            m = SECTION_PATTERN.match(line)
            if m:
                section = m.group(1)
                if section not in VALID_SECTIONS:
                    result.errors.append(
                        f"行 {i}: 不正なセクション名 `{section}`\n"
                        f"  有効: {', '.join(sorted(VALID_SECTIONS))}"
                    )
                current_sections.append(section)

    if not versions_found:
        result.errors.append("バージョンエントリが見つかりません")

    return result


if __name__ == "__main__":
    path = sys.argv[1] if len(sys.argv) > 1 else "CHANGELOG.md"
    if not Path(path).exists():
        print(f"❌ ファイルが見つかりません: {path}")
        sys.exit(1)

    result = validate_changelog(path)
    result.report()
    sys.exit(0 if result.is_valid else 1)

name: CHANGELOG Format Check

on:
  push:
    branches:
      - "release/**"
  pull_request:
    paths:
      - "CHANGELOG.md"

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

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

      - name: Run CHANGELOG validator
        run: python tools/validate_changelog.py CHANGELOG.md

## 変更内容



## チェックリスト

- [ ] CHANGELOG.md の `[Unreleased]` セクションに変更内容を追記した
- [ ] 破壊的変更がある場合は `BREAKING CHANGE:` を先頭に付けた
- [ ] テストを追加・更新した
- [ ] API の変更がある場合、ドキュメントを更新した