# バッチ設計書 46-New-UnpackagedTerminalDistribution.ps1

## 概要

本ドキュメントは、Terminal AppXとXAML AppXから非パッケージ版（ポータブル版）のTerminalディストリビューションを作成するPowerShellスクリプト「New-UnpackagedTerminalDistribution.ps1」のバッチ設計書である。

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

Terminal AppXパッケージ（またはレイアウトデプロイメント）とXAML AppXパッケージを展開し、不要ファイルの除去、必要なXAML DLLのコピー、リソース（PRI）の統合を行った上で、ZIP形式のポータブル配布物を生成する。AppXとLayoutの2つのパラメータセットに対応している。

**業務上の目的・背景**：Windows TerminalはMicrosoft Store経由のAppXパッケージだけでなく、非パッケージ版（ポータブル版）としても配布される。ポータブル版はインストール不要でUSBドライブ等から直接実行できるため、企業環境やMicrosoft Storeが利用できない環境で需要がある。本バッチは、AppXパッケージからポータブル版ディストリビューションを自動生成し、配布用ZIPファイルを作成する。

**バッチの実行タイミング**：リリースビルドプロセスにおいて、AppXパッケージ生成後に実行される。CI/CDパイプラインのパッケージング工程で実行される。

**主要な処理内容**：
1. MakeAppx.exeの存在を確認する
2. AppXマニフェストを読み取り、パッケージ名・バージョン・アーキテクチャを取得する
3. Terminal AppXをMakeAppx.exeで展開する（Layoutモードの場合はコピー）
4. XAML AppXをMakeAppx.exeで展開し、アーキテクチャ整合性を検証する
5. 不要ファイル（*.xml、*.winmd、Appx*、タイル/ロゴ画像等）を除去する
6. XAML DLL（Microsoft.UI.Xaml.dll、Microsoft.UI.Xaml/）をTerminalディレクトリにコピーする
7. Merge-TerminalAndXamlResources.ps1を呼び出してリソース（PRI）を統合する
8. ポータブルモードマーカーファイル（.portable）を配置する（オプション）
9. AppXモードの場合はZIPファイルを生成し、Layoutモードの場合はディレクトリパスを返す

**前後の処理との関連**：Merge-TerminalAndXamlResources.ps1（No.50）を内部で呼び出す。入力となるAppXパッケージはビルドプロセスで生成される。出力はDraft-TerminalReleases.ps1（No.54）等のリリーススクリプトで使用される。

**影響範囲**：ポータブル版ディストリビューションの配布物に直接影響する。不備はポータブル版の起動失敗やリソース不足に直結する。

## バッチ種別

パッケージング

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（リリースビルド時） |
| 実行時刻 | ビルドプロセス依存 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | CI/CDパイプライン／手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| MakeAppx.exeの存在 | MakeAppxPathで指定されたパスにMakeAppx.exeが存在すること |
| Windows SDK | Windows 10 SDK (10.0.22621.0) がインストールされていること（デフォルトパス使用時） |
| Terminal AppXまたはLayout | TerminalAppXまたはTerminalLayoutのいずれかが指定されていること |
| XAML AppX | XamlAppXパラメータに有効なAppXファイルが指定されていること |
| Merge-TerminalAndXamlResources.ps1 | 同一ディレクトリにMerge-TerminalAndXamlResources.ps1が存在すること |

### 実行可否判定

MakeAppx.exeの存在チェックを行い、存在しない場合はエラーメッセージを出力してExit 1で終了する。TerminalAppXとXamlAppXはValidateScriptによるファイル存在チェックが行われる。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| TerminalAppX | string | Yes（AppXセット） | なし | Terminal AppXファイルのパス。ValidateScriptでLeaf存在チェック |
| TerminalLayout | string | Yes（Layoutセット） | なし | Terminalレイアウトデプロイメントディレクトリのパス。ValidateScriptでContainer存在チェック |
| XamlAppX | string | Yes | なし | XAML AppXファイルのパス。ValidateScriptでLeaf存在チェック |
| Destination | string | No | "." | 出力先ディレクトリ |
| MakeAppxPath | string | No | C:\Program Files (x86)\Windows Kits\10\bin\10.0.22621.0\x64\MakeAppx.exe | MakeAppx.exeのパス |
| PortableMode | switch | No | Layoutセットの場合true、AppXセットの場合false | ポータブルモードマーカーファイルを含めるかどうか |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Terminal AppX | .appx/.msix | Windows TerminalのAppXパッケージ |
| Terminal Layout | ディレクトリ | Terminalのレイアウトデプロイメントディレクトリ |
| XAML AppX | .appx/.msix | Microsoft.UI.XamlのAppXパッケージ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| {Destination}/{pfn}_{version}_{arch}.zip | ZIP | AppXモード時：ポータブル版ディストリビューションのZIPファイル |
| terminal-{version}/ | ディレクトリ | Layoutモード時：展開されたTerminalディレクトリ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | {PackageFamilyName}_{Version}_{Architecture}.zip（AppXモード時） |
| 出力先 | Destinationパラメータで指定 |
| 文字コード | バイナリ（ZIP形式） |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. MakeAppx.exe存在チェック
   └─ 存在しない場合はWrite-ErrorでExit 1
2. AppXマニフェスト読み取り
   ├─ AppXモード: tar.exeでAppxManifest.xmlを抽出
   └─ Layoutモード: LayoutディレクトリからAppxManifest.xmlを読み取り
3. パッケージ情報取得
   └─ Package.Identity.Name, Version, ProcessorArchitectureを取得
4. Terminal展開
   ├─ AppXモード: MakeAppx.exe unpackで展開
   └─ Layoutモード: Copy-Item -Recurseでコピー
5. XAML AppX展開
   └─ MakeAppx.exe unpackで展開
6. 整合性チェック
   ├─ XAMLパッケージ名がMicrosoft.UI.Xaml*であること
   └─ XAMLパッケージのアーキテクチャがTerminalと一致すること
7. 不要ファイル除去
   └─ *.xml, *.winmd, Appx*, Images/*Tile*, Images/*Logo* を削除（除外リストを考慮）
8. XAML DLLコピー
   └─ Microsoft.UI.Xaml.dll, Microsoft.UI.Xaml/ をTerminalディレクトリにコピー
9. リソース統合
   └─ Merge-TerminalAndXamlResources.ps1を呼び出してresources.priを統合
10. ポータブルモードマーカー配置
    └─ PortableMode有効時に.portableファイルを作成
11. パッケージング
    ├─ AppXモード: tar -c --format=zip でZIP作成後、一時ディレクトリを削除
    └─ Layoutモード: ディレクトリパスを返却
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{MakeAppx.exe存在?}
    B -->|なし| C[エラー・Exit 1]
    B -->|あり| D[AppXマニフェスト読み取り]
    D --> E[パッケージ情報取得]
    E --> F{パラメータセット}
    F -->|AppX| G[MakeAppx.exe unpackでTerminal展開]
    F -->|Layout| H[Copy-ItemでTerminalコピー]
    G --> I[MakeAppx.exe unpackでXAML展開]
    H --> I
    I --> J{XAML検証OK?}
    J -->|NG| K[Throw エラー]
    J -->|OK| L[不要ファイル除去]
    L --> M[XAML DLLコピー]
    M --> N[Merge-TerminalAndXamlResources.ps1呼び出し]
    N --> O{PortableMode?}
    O -->|Yes| P[.portableファイル作成]
    O -->|No| Q{パラメータセット}
    P --> Q
    Q -->|AppX| R[ZIP作成・一時ディレクトリ削除]
    Q -->|Layout| S[ディレクトリパス返却]
    R --> T[バッチ終了]
    S --> T
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| Exit 1 | MakeAppx.exe未検出 | MakeAppxPathにMakeAppx.exeが存在しない | Windows SDKをインストールするか正しいパスを指定する |
| Throw | Terminal展開失敗 | MakeAppx.exe unpackがゼロ以外の終了コードを返す | AppXファイルの整合性を確認する |
| Throw | XAML展開失敗 | MakeAppx.exe unpackがゼロ以外の終了コードを返す | XAML AppXファイルの整合性を確認する |
| Throw | XAMLパッケージ名不正 | XAMLパッケージ名がMicrosoft.UI.Xaml*でない | 正しいXAML AppXファイルを指定する |
| Throw | アーキテクチャ不一致 | XAMLとTerminalのアーキテクチャが異なる | 同一アーキテクチャのAppXを指定する |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（リトライ機構なし） |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

$ErrorActionPreference = 'Stop'が設定されているため、エラー発生時は即座にスクリプトが停止する。入力AppXファイルの整合性（アーキテクチャ、バージョン）を確認し、再実行する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし（ファイル操作） |
| コミットタイミング | ZIP作成時に一括処理 |
| ロールバック条件 | AppXモード時、正常完了時に一時ディレクトリが削除される |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 2つのAppXパッケージ（Terminal + XAML） |
| 目標処理時間 | 数分以内 |
| メモリ使用量上限 | 展開されたAppXの合計サイズに依存 |

## 排他制御

一時ディレクトリにランダムな名前を使用して衝突を回避している（`tmp{4桁16進数}.tmp`形式）。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| MakeAppx.exe出力 | unpack実行時 | MakeAppx.exeの標準出力（Out-Nullで抑制） |
| Verbose出力 | リソース統合時 | Merge-TerminalAndXamlResources.ps1のVerbose出力 |
| エラーログ | エラー発生時 | Throw/Write-Errorのメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ビルドエラー | 発生時 | ビルドシステム（CI/CD） |

## 備考

- CmdletBindingが指定されており、-Verboseスイッチが利用可能。
- 2つのパラメータセット（AppX/Layout）があり、TerminalAppXとTerminalLayoutは排他的。
- 不要ファイル除去リストは`$filesToRemove`で定義されており、`$filesToKeep`で例外指定が可能（現在は空）。
- `$filesToCopyFromXaml`で定義されたファイル（Microsoft.UI.Xaml.dll、Microsoft.UI.Xamlディレクトリ）のみがXAMLパッケージからコピーされる。.winmdは含まれない。
- ZIP作成にはtar.exeを使用している（`tar -c --format=zip`）。
- PortableModeスイッチはLayoutセットの場合デフォルトtrueとなる。
- ソースファイルパス: `build/scripts/New-UnpackagedTerminalDistribution.ps1`
