# バッチ設計書 55-New-TerminalStackedChangelog

## 概要

本ドキュメントは、複数のリビジョン範囲からMarkdown形式のチェンジログを生成するPowerShellスクリプト「New-TerminalStackedChangelog.ps1」のバッチ設計書である。

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

本バッチは、指定された複数のGitリビジョン範囲（例：1.9..release-1.9, 1.10..release-1.10）からコミットログを取得し、重複コミットの検出・外部コントリビューターへの謝辞付きのMarkdown形式チェンジログを生成する。複数リリースブランチにまたがるチェンジログを「スタック」形式で生成することが特徴である。

**業務上の目的・背景**：Windows Terminalのリリースノート作成にあたり、複数のリリースブランチにまたがる変更を一覧化する必要がある。本バッチは、git logからコミット情報を自動抽出し、Microsoft社員と外部コントリビューターを区別した帰属付きチェンジログを生成することで、リリースノート作成を支援する。

**バッチの実行タイミング**：リリースノート作成時にリリースエンジニア（Dustin Howett氏）が手動で実行する。

**主要な処理内容**：
1. 各リビジョン範囲についてgit logでコミット情報（著者名、メール、サブジェクト）を取得
2. メールアドレスからMicrosoft社員かどうかを判定
3. GitHub noreplyメールからユーザー名を推定
4. コミットをサブジェクトでグループ化し重複を検出
5. 各リビジョン範囲での存在状況をマトリクス表示
6. 外部コントリビューターには"thanks @username!"の謝辞を付与

**前後の処理との関連**：本バッチの出力はリリースノートの原稿として使用される。Gitリポジトリのリリースブランチ・タグが前提条件となる。

**影響範囲**：標準出力にMarkdown形式のチェンジログが出力される。ファイルやシステムへの変更は行わない。

## バッチ種別

レポート生成

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（リリースノート作成時） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| PowerShell 7.0以上 | #Requires -Version 7.0 |
| Gitリポジトリ | git logが実行可能なリポジトリ内であること |
| リビジョン範囲 | 指定されたブランチ・タグがローカルまたはリモートに存在すること |

### 実行可否判定

指定されたリビジョン範囲がgit logで解決可能であれば実行される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| RevisionRanges | string[] | No | - | Gitリビジョン範囲の配列（例："1.9..release-1.9"） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Git log | テキスト | git logの出力（著者名、メール、サブジェクト） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | Markdown | チェンジログ（各コミットを1行エントリとして出力） |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| 出力先 | 標準出力（パイプやリダイレクトでファイル保存可能） |
| 形式 | Markdownリスト形式 |
| エントリ形式 | "* [{リビジョンマトリクス}] {サブジェクト} (thanks @{ユーザー名}!)" |

## 処理フロー

### 処理シーケンス

```
1. リビジョン範囲のループ
   └─ 各RevisionRangeについてgit logを実行
2. コミット情報の解析
   └─ FS区切り（0x1C）でAuthor/Email/Subjectを分割
3. エントリオブジェクトの構築
   └─ Microsoft社員判定・GitHub username推定を付加
4. リビジョンヘッダーの出力
   └─ 各リビジョン範囲のラベルを表示
5. サブジェクトでグループ化
   └─ 重複コミットを検出
6. マトリクス付きチェンジログの出力
   └─ 各リビジョン範囲での存在を"X"マークで表示
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[リビジョン範囲をループ]
    B --> C[git log --first-parent でコミット取得]
    C --> D[FS区切りでAuthor/Email/Subject解析]
    D --> E[Microsoft社員判定]
    E --> F[GitHubユーザー名推定]
    F --> G{次のリビジョン範囲あり?}
    G -->|あり| B
    G -->|なし| H[リビジョンヘッダー出力]
    H --> I[Subjectでグループ化]
    I --> J[リビジョンマトリクス付きエントリ出力]
    J --> K[バッチ終了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | Git error | 指定リビジョン範囲が解決できない | ローカルリポジトリのfetch/pullを実行 |

### リトライ仕様

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

### 障害時対応

リモートブランチを参照する場合は `origin/` プレフィックスを付けて実行する。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数百コミット程度 |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

読み取り専用処理のため、排他制御は不要。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| なし | - | 標準出力にチェンジログを直接出力する |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 特になし | N/A | N/A |

## 備考

- --first-parent オプションでマージコミットのみを対象としている
- Microsoft社員の判定は @microsoft.com メールアドレスおよび特定のユーザー（pankaj.d*）で行う
- GitHub noreplyメール（{数字}+{ユーザー名}@users.noreply.github.com）からユーザー名を正規表現で抽出する
- 重複コミット（複数リビジョン範囲に存在）はマトリクス表示で "[X ] " のように示される
- スクリプトコメントにDustin Howett氏の利用が言及されている
