# バッチ設計書 5-checkChangelog.mjs

## 概要

本ドキュメントは、Jestモノレポにおける CHANGELOG.md 検証バッチ `checkChangelog.mjs` の設計仕様を記載したものです。このバッチは CHANGELOG.md ファイル内の GitHub リンクの整合性を検証し、リンク番号と URL 内の issue/PR 番号が一致するかをチェックします。

### 本バッチの処理概要

**業務上の目的・背景**：CHANGELOG.md は Jest の変更履歴を記録する重要なドキュメントであり、各エントリには関連する GitHub の issue や PR へのリンクが含まれます。手動での記述ミスにより、表示される番号とリンク先の番号が不一致になることがあります。本バッチは、このような不整合を自動検出し、ドキュメントの品質を保証します。

**バッチの実行タイミング**：開発者が `yarn check-changelog` コマンドを実行した際に随時実行されます。CI/CD パイプラインでは、プルリクエストの検証時に自動実行され、不整合がある場合はビルドが失敗します。

**主要な処理内容**：
1. `CHANGELOG.md` ファイルを読み込む
2. 正規表現で GitHub リンク（`[#番号](URL)` 形式）を検出
3. 各リンクについて、表示番号と URL 内の番号を比較
4. 不一致がある場合、ファイル名・行番号・列番号・エラー内容を出力
5. エラーがある場合は終了コード 1 で終了

**前後の処理との関連**：`yarn lint` コマンドの一部として実行されることが多いです。CHANGELOG.md の変更を含むプルリクエストでは必ず実行されます。

**影響範囲**：`CHANGELOG.md` ファイルのみが検証対象です。検証に失敗した場合、CI/CD パイプラインが停止します。

## バッチ種別

検証処理 / 品質チェック / ドキュメント検証

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（開発者操作時）/ CI/CD |
| 実行時刻 | 任意 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | `yarn check-changelog` コマンド実行 / CI/CDパイプライン |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | ^18.14.0 \|\| ^20.0.0 \|\| ^22.0.0 \|\| >=24.0.0 |
| CHANGELOG.md 存在 | リポジトリルートに CHANGELOG.md が存在すること |

### 実行可否判定

- `CHANGELOG.md` ファイルが存在し、読み取り可能であること
- ファイルが UTF-8 エンコーディングであること

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | コマンドライン引数は受け付けない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| CHANGELOG.md | Markdown | リポジトリルートの変更履歴ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準エラー出力 | テキスト | エラーメッセージ（不整合があった場合） |

### 出力ファイル仕様

ファイル出力は行いません。

## 処理フロー

### 処理シーケンス

```
1. ファイル読み込み
   └─ CHANGELOG.md を UTF-8 で読み込み
2. 行ごとの処理（ループ）
   ├─ 正規表現でリンクをマッチ
   ├─ 各マッチについて番号を比較
   │   ├─ match[1]: 表示番号
   │   └─ match[3]: URL内の番号
   └─ 不一致の場合、エラーメッセージを出力
3. 終了処理
   ├─ エラーあり: process.exit(1)
   └─ エラーなし: process.exit(0)
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[CHANGELOG.md 読み込み]
    B --> C[行ごとにループ]
    C --> D{リンクパターン検出?}
    D -->|あり| E{表示番号 == URL番号?}
    E -->|不一致| F[エラーメッセージ出力]
    E -->|一致| G[次のマッチ]
    F --> H[error = true]
    H --> G
    G --> D
    D -->|なし| I[次の行]
    I --> C
    C -->|全行処理完了| J{error フラグ?}
    J -->|true| K[process.exit 1]
    J -->|false| L[process.exit 0]
    K --> M[バッチ終了]
    L --> M
```

## データベース操作仕様

### 操作別データベース影響一覧

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | - | - | データベースへのアクセスなし |

### テーブル別操作詳細

データベース操作は発生しません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| Exit 1 | リンク不整合 | 表示番号と URL 番号が異なる | CHANGELOG.md のリンクを修正 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

1. エラーメッセージの行番号・列番号を確認
2. 該当行のリンクを確認し、表示番号または URL を修正
3. 再度 `yarn check-changelog` を実行して検証

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（読み取り専用） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1ファイル（数千行） |
| 目標処理時間 | 1秒未満 |
| メモリ使用量上限 | ファイルサイズに依存 |

## 排他制御

- 読み取り専用のため、排他制御は不要
- 複数プロセスでの同時実行可能

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| エラーログ | 不整合検出時 | `CHANGELOG.md:{行}:{列}: error: Link is incorrect: [リンクテキスト]` |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 非0 | CI/CDパイプライン |

## 備考

- 検証対象のリンク形式: `[#番号](https://github.com/facebook/jest/(issues|pull)/番号)`
- 旧リポジトリ URL（facebook/jest）がハードコードされている
- 新しい jestjs/jest リポジトリの URL は検証対象外となる可能性がある
- 正規表現: `/\[#(\d+)]\(https:\/\/github.com\/facebook\/jest\/(issues|pull)\/(\d+)\)/g`
