チェンジログ保守

概要

Keep a ChangelogとSemantic Versioningなどの業界のベストプラクティスに従って、プロジェクトへのすべての重要な変更を記録した構造化されたチェンジログを作成・保守します。

使用場面

• バージョン履歴のドキュメント化
• リリースノートの生成
• 破壊的変更の追跡
• マイグレーションガイドの作成
• 廃止予定の通知
• セキュリティパッチのドキュメント化
• 機能のお知らせ
• バグ修正の追跡

CHANGELOG.md テンプレート

# Changelog

このプロジェクトへのすべての重要な変更はこのファイルに記録されます。

このフォーマットは [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) に基づいており、
このプロジェクトは [Semantic Versioning](https://semver.org/spec/v2.0.0.html) に従っています。

## [Unreleased]

### Added

- 追加された新機能または機能
- 複数の項目を含むことができます

### Changed

- 既存機能の変更
- 機能の動作方法の更新

### Deprecated

- 今後のリリースで削除予定の機能
- 削除予定時期を含める

### Removed

- 削除された機能
- 以前廃止予定だった機能

### Fixed

- バグ修正
- セキュリティパッチ

### Security

- 修正されたセキュリティ脆弱性
- 重要なセキュリティアップデート

## [2.1.0] - 2025-01-15

### Added

- GitHub と Google に対応した OAuth2 認証サポートを追加
- カスタマイズ可能なレイアウト用の新しいダッシュボードウィジェットシステム
- 複数レコードを処理するためのバルク操作API
- カスタムテンプレート対応のExcelエクスポート機能
- すべてのページでダークモードテーマサポートを追加
- リアルタイム通知用のWebSocketサポート
- 既存のRESTエンドポイント対応のGraphQL API
- 10言語の国際化サポートを追加
  - スペイン語、フランス語、ドイツ語、イタリア語、ポルトガル語
  - 日本語、韓国語、中国語（簡体字/繁体字）、アラビア語

### Changed

- 改善されたレイアウトとパフォーマンスを備えたユーザープロフィールページを更新
- RESTからメインAPIエンドポイント用のGraphQLへ移行
- より多くのコンテキストと提案を含む改善されたエラーメッセージ
- より優れたセキュリティのための認証システムをリファクタリング
- 依存関係を最新バージョンに更新
  - React 18.2.0 → 19.0.0
  - Node.js 16.x → 18.x（最小必須バージョン）
  - PostgreSQL 13 → 14
- デフォルトのページネーションを20項目から50項目に変更
- 検索アルゴリズムを改善し、3倍高速化

### Deprecated

- REST API v1 エンドポイント（v3.0.0 で削除予定）
  - GraphQL API または REST API v2 を使用してください
  - マイグレーションガイド: [docs/migration-v1-to-v2.md](docs/migration-v1-to-v2.md)
- レガシー認証トークン（2025年06月01日までに削除）
  - JWT トークンで置き換える
- `config.json` の古い設定フォーマット
  - `config.yaml` の新しい YAML フォーマットを使用

### Removed

- 廃止予定の `/api/users/list` エンドポイントを削除
  - `/api/v2/users` を代わりに使用
- Internet Explorer 11 のサポートを削除
  - 最小ブラウザバージョン: Chrome 90+、Firefox 88+、Safari 14+、Edge 90+
- jQuery 依存関係を削除（純粋な JavaScript に変更）
- 古いダッシュボードウィジェットを削除（新しいウィジェットシステムで置き換え）

### Fixed

- 重複請求を引き起こす注文処理のレースコンディションを修正
  - 影響を受けたバージョン: 2.0.0 - 2.0.5
  - Issue: [#1234](https://github.com/user/repo/issues/1234)
- WebSocket接続のメモリリークを修正
- 日付ピッカーのタイムゾーン処理が不正な問題を修正
- CSV エクスポートがすべての列を含まない問題を修正
- フォーム送信の CSRF 脆弱性を修正（CVE-2025-12345）
- ナビゲーションメニューのアクセシビリティの問題を修正
  - キーボードで完全にナビゲート可能
  - スクリーンリーダー対応
- iPad Pro のモバイルレスポンシブの問題を修正
- 検索の SQL インジェクション脆弱性を修正（CVE-2025-12346）
  - **セキュリティインパクト**: 高
  - **影響を受けたバージョン**: 2.0.0 - 2.0.9
  - **推奨アクション**: すぐにアップグレード

### Security

- **重大**: ユーザー検索の SQL インジェクションを修正（CVE-2025-12346）
  - インパクト: 高 - 不正なデータベースアクセスを許可
  - 影響: v2.0.0 から v2.0.9
  - アクション: すぐに v2.1.0 にアップグレード
- コメントレンダリングの XSS 脆弱性を修正（CVE-2025-12347）
- 既知のセキュリティ脆弱性を持つすべての依存関係を更新
- すべての API エンドポイントにレート制限を実装
- すべてのフォームに CSRF 保護を追加
- Content Security Policy ヘッダーを有効化

## [2.0.5] - 2025-01-08

### Fixed

- ホットフィックス: エクスポート機能でデータが失われる重大なバグを修正
- LDAP 統合の認証の問題を修正
- 大規模なデータセットでのパフォーマンス低下を解決

### Security

- 認証バイパス脆弱性にパッチを適用（CVE-2025-12344）

## [2.0.0] - 2025-01-01

### Added

- モダンなルック・アンド・フィールを備えた完全な UI リデザイン
- より良いパフォーマンスを実現する新しい REST API v2
- ユーザーロールとパーミッションシステム
- すべての管理アクションの監査ログ
- メールテンプレートのカスタマイズ
- 二要素認証（2FA）
- API レート制限
- データベースバックアップの自動化

### Changed

- **破壊的変更**: API レスポンス形式を XML から JSON に変更
  - すべての API コンシューマーが統合を更新する必要があります
  - マイグレーションガイドを参照してください: [docs/api-v1-to-v2.md](docs/api-v1-to-v2.md)
- **破壊的変更**: 一貫性を目的としてデータベーステーブル名を変更
  - `user` → `users`
  - `order` → `orders`
  - マイグレーションスクリプトを実行してください: `npm run migrate:v2`
- **破壊的変更**: セッションベースから JWT への認証に変更
  - 既存のセッションは無効になります
  - ユーザーは再度ログインする必要があります
- データベースクエリパフォーマンスを50%改善
- 最小 Node.js バージョンを 16.x に更新

### Removed

- **破壊的変更**: Node.js 12 および 14 のサポートを削除
- **破壊的変更**: 廃止予定の設定オプションを削除
  - `USE_OLD_AUTH` - JWT 認証を使用
  - `LEGACY_MODE` - サポートされなくなりました

### マイグレーションガイド

**v1.x から v2.0:**

1. Node.js をバージョン 16 以上に更新
2. API 統合を更新します:

   ```javascript
   // 旧版 (v1)
   fetch("/api/users/list")
     .then((res) => res.text())
     .then((xml) => parseXML(xml));

   // 新版 (v2)
   fetch("/api/v2/users")
     .then((res) => res.json())
     .then((data) => console.log(data));
   ```

3. データベースマイグレーションを実行:
   ```bash
   npm run migrate:v2
   ```
4. 環境変数を更新:

   ```env
   # 削除
   USE_OLD_AUTH=true
   LEGACY_MODE=true

   # 追加
   JWT_SECRET=your-secret-key
   JWT_EXPIRES_IN=7d
   ```

## [1.5.2] - 2024-12-15

### Fixed

- ユーザーリストページのページネーションバグを修正
- レポートのタイムゾーンの問題を解決
- メール通知の遅延を修正

## [1.5.0] - 2024-12-01

### Added

- 新しいレポーティングダッシュボード
- ユーザープロフィール用のカスタムフィールド
- 統合用の Webhook サポート

### Changed

- 検索パフォーマンスを改善
- UI コンポーネントライブラリを更新

## [1.0.0] - 2024-10-01

### Added

- 初回リリース
- ユーザー管理
- 基本的な API
- 認証と認可
- データベースマイグレーション
- ユニットテストと統合テスト

[Unreleased]: https://github.com/user/repo/compare/v2.1.0...HEAD
[2.1.0]: https://github.com/user/repo/compare/v2.0.5...v2.1.0
[2.0.5]: https://github.com/user/repo/compare/v2.0.0...v2.0.5
[2.0.0]: https://github.com/user/repo/compare/v1.5.2...v2.0.0
[1.5.2]: https://github.com/user/repo/compare/v1.5.0...v1.5.2
[1.5.0]: https://github.com/user/repo/compare/v1.0.0...v1.5.0
[1.0.0]: https://github.com/user/repo/releases/tag/v1.0.0

リリースノートテンプレート

# リリースノート - バージョン 2.1.0

**リリース日:** 2025年1月15日

**ダウンロード:** [v2.1.0](https://github.com/user/repo/releases/tag/v2.1.0)

## 🎉 ハイライト

- **OAuth2 認証**: GitHub と Google でサインイン
- **GraphQL API**: REST API に加えて新しい GraphQL エンドポイント
- **ダークモード**: すべてのページでダークモード対応
- **リアルタイム通知**: WebSocket による ライブアップデート
- **10言語対応**: 国際化サポートを拡大

## 📦 新機能

### OAuth2 認証

GitHub または Google アカウントを使用してサインインできるようになりました。設定 > 認証で OAuth を設定してください。

```javascript
// 設定で OAuth を有効化
{
  "auth": {
    "providers": ["github", "google"],
    "github": {
      "clientId": "your-client-id",
      "clientSecret": "your-client-secret"
    }
  }
}

GraphQL API

より効率的なクエリのために GraphQL を使用してデータにアクセスしてください:

query GetUser {
  user(id: "123") {
    id
    name
    email
    orders {
      id
      total
      items {
        product {
          name
          price
        }
      }
    }
  }
}

エンドポイント: https://api.example.com/graphql ドキュメント: GraphQL API ドキュメント

ダークモード

設定 > 外観でダークモードを有効にするか、システム設定を使用してください。

🔧 改善

• 3倍高速な検索: 改善された検索アルゴリズム
• より良いエラーメッセージ: 提案を含むより有用なエラーメッセージ
• パフォーマンスの強化: ページロード速度が50%向上
• モバイル改善: タブレット用のレスポンシブデザイン改善

🐛 バグ修正

• 注文処理のレースコンディションを修正
• WebSocket接続のメモリリークを修正
• 日付ピッカーのタイムゾーン処理を修正
• ナビゲーションのアクセシビリティの問題を修正

🔒 セキュリティアップデート

• 重大: ユーザー検索の SQL インジェクション脆弱性を修正（CVE-2025-12346）
  • インパクト: 高 - 不正なデータベースアクセスを許可
  • 影響: v2.0.0 から v2.0.9
  • アクション: v2.0.0 - v2.0.9 を使用している場合、すぐにアップグレード
• コメントレンダリングの XSS 脆弱性を修正（CVE-2025-12347）
• 既知のセキュリティ脆弱性を含むすべての依存関係を更新
• すべての API エンドポイントにレート制限を実装
• すべてのフォームに CSRF 保護を追加
• Content Security Policy ヘッダーを有効化

📋 破壊的変更

廃止予定の API（v3.0.0 で削除）

以下の REST API v1 エンドポイントは廃止予定であり、v3.0.0 で削除されます:

旧エンドポイント	新エンドポイント	マイグレーションガイド
/api/users/list	/api/v2/users	リンク
/api/products/search	/api/v2/products?q=	リンク

タイムライン: これらのエンドポイントは 2025 年 6 月まで引き続き機能します。

更新された依存関係

• Node.js: 最小バージョンは 18.x になりました（従来は 16.x）
• React: 19.0.0 にアップグレード
• PostgreSQL: 最小バージョンは 14 になりました（従来は 13）

📖 ドキュメント

• 完全なチェンジログ
• API マイグレーションガイド
• アップグレードガイド
• API ドキュメント

🔄 アップグレード

v2.0.x から

# まずデータベースをバックアップ
pg_dump your_database > backup.sql

# 最新バージョンをプル
git pull origin main

# 依存関係をインストール
npm install

# マイグレーションを実行
npm run migrate

# アプリケーションを再開
npm start

v1.x から

詳細なアップグレード手順については、v1 から v2 へのマイグレーションガイドを参照してください。

🙏 貢献者

このリリースを実現してくれたすべての貢献者に感謝します:

• @contributor1 - OAuth2 実装
• @contributor2 - GraphQL API
• @contributor3 - ダークモード
• @contributor4 - パフォーマンス改善

📞 サポート

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• ドキュメント: docs.example.com
• メール: support@example.com

🔜 次は?

v2.2.0 の予定:

• 高度な分析ダッシュボード
• 拡張性のためのプラグインシステム
• モバイルアプリ（iOS および Android）
• チームコラボレーション機能の改善

お楽しみに!

## セマンティックバージョニングガイド

バージョン: MAJOR.MINOR.PATCH

MAJOR バージョン: 互換性のない API の変更 MINOR バージョン: 機能追加（後方互換性あり） PATCH バージョン: 後方互換性のあるバグ修正

例:

• 1.0.0 → 1.0.1: バグ修正
• 1.0.1 → 1.1.0: 新機能（後方互換性あり）
• 1.1.0 → 2.0.0: 破壊的変更

## ベストプラクティス

### ✅ すべき事

- Keep a Changelog 形式に従う
- セマンティックバージョニングを使用
- 破壊的変更を目立つように記録
- マイグレーションガイドを含める
- 関連する Issue/PR にリンク
- 変更を分類する（Added、Changed、Fixed など）
- セキュリティ修正を別のセクションに記載
- すべてのリリースに日付を付ける（YYYY-MM-DD 形式）
- リリースタグにリンク
- タイムラインを含めて廃止を記録
- アップグレード手順を含める
- 貢献者について言及

### ❌ してはいけない事

- 破壊的変更のドキュメント化をスキップ
- リリース前にチェンジログを更新し忘れる
- 複数のタイプを1つのカテゴリに混ぜる
- 曖昧な説明を使用する
- リリースの日付をスキップ
- セマンティックバージョニングを忘れる
- セキュリティ問題を隠す

## リソース

- [Keep a Changelog](https://keepachangelog.com/)
- [Semantic Versioning](https://semver.org/)
- [Conventional Commits](https://www.conventionalcommits.org/)
- [Release Drafter](https://github.com/release-drafter/release-drafter)