# バッチ設計書 21-check-changelog.sh

## 概要

本ドキュメントは、lua-language-serverプロジェクトにおけるchangelogファイル更新チェック用スクリプト（check-changelog.sh）の設計仕様を定義する。

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

このバッチは、GitHub Pull Request（PR）作成時にchangelog.mdファイルが更新されているかを自動的に検証するスクリプトである。GitHub Actionsワークフローから呼び出され、CI/CDパイプラインの一部として機能する。

**業務上の目的・背景**：オープンソースプロジェクトにおいて、変更履歴（changelog）の維持は非常に重要である。ユーザーはchangelogを参照してバージョン間の変更点を確認し、アップグレードの判断材料とする。本バッチは、PRがマージされる前にchangelogが更新されていることを強制することで、変更履歴の漏れを防止し、プロジェクトのドキュメント品質を維持する。開発者が変更内容をchangelogに記載することを忘れた場合、CIが失敗してPRのマージをブロックするため、changelog更新の習慣化を促進する。

**バッチの実行タイミング**：GitHub Pull Requestが作成された時（opened）、またはPRが更新された時（synchronize）に自動実行される。対象はmasterブランチへのPRのみである。

**主要な処理内容**：
1. git fetchでベースブランチ（通常master）の最新情報を取得
2. git fetchでPRのソースブランチの情報を取得
3. git diffでベースブランチとPRブランチ間の変更ファイル一覧を取得
4. 変更ファイル一覧にchangelog.mdが含まれているかをgrepで確認
5. changelog.mdが更新されていれば終了コード0（成功）、されていなければ終了コード1（失敗）を返す

**前後の処理との関連**：本バッチは独立したCI/CDステップとして実行され、他のワークフロー（build、test）とは並行して実行される。本バッチの成否はPRのマージ可否に影響を与えるが、ビルドやテストの実行には影響しない。

**影響範囲**：本バッチはGitHub Actions上で実行され、リポジトリのコードやファイルを変更することはない。PRのステータス（CIの成功/失敗）のみに影響する。

## バッチ種別

CI/CD検証処理（Pull Requestバリデーション）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | イベント駆動（PR作成/更新時） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | GitHub Actions（pull_request: opened, synchronize） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| GitHub Actions環境 | ubuntu-latestランナー上で実行される |
| 環境変数GITHUB_BASE_REF | PRのベースブランチ名（通常master） |
| 環境変数GITHUB_SOURCE_REF | PRのソースブランチ名（PRの参照名） |
| Git履歴 | fetch-depth: 0でクローンされ、全履歴が利用可能 |

### 実行可否判定

- masterブランチへのPull Requestであること
- PRイベントがopenedまたはsynchronizeであること

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| GITHUB_BASE_REF | 環境変数 | Yes | - | PRのベースブランチ名 |
| GITHUB_SOURCE_REF | 環境変数 | Yes | - | PRのソースブランチ名 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Gitリポジトリ | Git | ローカルにクローンされたリポジトリ |
| changelog.md | Markdown | 変更履歴ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 成功/失敗メッセージ |
| 終了コード | 数値 | 0: 成功、1: 失敗 |

### 出力ファイル仕様

本バッチはファイル出力を行わない。

## 処理フロー

### 処理シーケンス

```
1. 初期化
   └─ set -e でエラー時即座終了を設定
2. 定数定義
   └─ CHANGELOG_FILE="changelog.md" を設定
3. ベースブランチ取得
   └─ git fetch origin $GITHUB_BASE_REF でベースブランチの最新を取得
4. PRブランチ取得
   └─ git fetch でPRブランチの情報を取得
5. 差分チェック
   └─ git diff --name-only で変更ファイル一覧を取得し、grepでchangelog.mdを検索
6. 結果判定
   └─ changelog.mdが含まれていれば成功メッセージを出力して終了コード0
   └─ 含まれていなければ失敗メッセージを出力して終了コード1
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[set -e 設定]
    B --> C[CHANGELOG_FILE定義]
    C --> D[git fetch ベースブランチ]
    D --> E[git fetch PRブランチ]
    E --> F{git diff でchangelog.md検出?}
    F -->|あり| G[成功メッセージ出力]
    F -->|なし| H[失敗メッセージ出力]
    G --> I[exit 0]
    H --> J[exit 1]
    I --> K[バッチ終了]
    J --> K
```

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

本バッチはデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | changelog未更新 | PRでchangelog.mdが変更されていない | PRにchangelog.mdの変更を追加する |
| 非0 | Git操作失敗 | git fetchが失敗した場合 | ネットワーク接続、認証情報を確認 |

### リトライ仕様

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

### 障害時対応

- スクリプトが失敗した場合、GitHub Actions UIでログを確認
- changelog.mdを更新してPRを再プッシュする
- ネットワークエラーの場合はワークフローを再実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（データベース操作なし） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1PR/実行 |
| 目標処理時間 | 10秒以内 |
| メモリ使用量上限 | 特に制限なし（軽量処理） |

## 排他制御

同一PRに対する複数のワークフロー実行は、GitHub Actionsのconcurrencyによって制御される可能性がある。本スクリプト自体は排他制御を行わない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 成功ログ | changelog更新確認時 | "Thank you for updating the changelog!" |
| 失敗ログ | changelog未更新時 | "Changelog has not been updated. Please update changelog.md!" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ワークフロー失敗 | 1回 | PRステータスチェック |

## 備考

- 本スクリプトは`.github/workflows/changelog.yml`から呼び出される
- changelogの更新が不要なPR（例：ドキュメントのみの変更）でも強制される点に注意
- 必要に応じて、特定のラベルが付いたPRをスキップするロジックの追加を検討可能
