# バッチ設計書 41-local-webpage

## 概要

本ドキュメントは、clojure-lspプロジェクトの`local-webpage`バッチ（Babashkaタスク）の設計を記述したものです。このバッチは、ドキュメント確認用のローカルWebページをDockerコンテナで起動するユーティリティタスクです。

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

このバッチは、clojure-lspプロジェクトのドキュメントをローカル環境で確認するためのWebサーバーを起動します。MkDocsベースのドキュメントサイトをDockerコンテナ内で実行し、開発者がブラウザでドキュメントの表示を確認できるようにします。

**業務上の目的・背景**：clojure-lspプロジェクトはMkDocsを使用してドキュメントサイトを生成しています。ドキュメントの変更をコミットする前に、ローカル環境でレンダリング結果を確認する必要があります。このバッチにより、開発者は本番環境にデプロイせずにドキュメントの見た目や動作を検証できます。Docker化されたMkDocs環境を使用することで、ローカル環境へのMkDocsインストールが不要となり、環境依存の問題を回避できます。

**バッチの実行タイミング**：開発者がドキュメントを編集し、その結果を確認したいときに手動で実行します。特に、CHANGELOGやREADMEの更新時、またはdocsディレクトリ内のMarkdownファイルを変更した際に使用されます。

**主要な処理内容**：
1. CHANGELOG.mdとREADME.mdをdocsディレクトリにコピー
2. imagesディレクトリをdocsディレクトリにコピー
3. Docker Hub（docker.pkg.github.com）にログイン
4. MkDocsドキュメントイメージをDockerで起動し、ポート8000でリッスン

**前後の処理との関連**：このバッチは独立したユーティリティであり、特定の前提バッチや後続バッチはありません。ただし、ドキュメントの最終確認後には、GitHubへのコミットとプッシュが想定されます。

**影響範囲**：ローカルのdocsディレクトリにファイルがコピーされます。ただし、これらのファイルは一時的なものであり、cleanタスクで削除対象となっています（docs/README.md、docs/CHANGELOG.md）。

## バッチ種別

ユーティリティ / ドキュメントプレビュー

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動） |
| 実行時刻 | なし（手動実行） |
| 実行曜日 | なし |
| 実行日 | なし |
| トリガー | 手動（`bb local-webpage`コマンド） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Docker環境 | Dockerがインストールされ、起動していること |
| Dockerログイン | docker.pkg.github.comへのアクセス権限があること |
| ポート8000 | ローカルのポート8000が使用可能であること |
| ファイル存在 | プロジェクトルートにCHANGELOG.md、README.md、imagesディレクトリが存在すること |

### 実行可否判定

特別な判定ロジックはありません。前提条件が満たされていれば実行可能です。Dockerログインに失敗した場合、処理は中断されます。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | このバッチはパラメータを受け取りません |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| CHANGELOG.md | Markdown | プロジェクトルートの変更履歴ファイル |
| README.md | Markdown | プロジェクトルートのREADMEファイル |
| images/ | ディレクトリ | プロジェクトルートの画像ディレクトリ |
| docs/ | ディレクトリ | MkDocsドキュメントディレクトリ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| docs/CHANGELOG.md | Markdown | コピーされた変更履歴ファイル |
| docs/README.md | Markdown | コピーされたREADMEファイル |
| docs/images/ | ディレクトリ | コピーされた画像ディレクトリ |
| http://localhost:8000 | HTTP | MkDocsサーバーのエンドポイント |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | CHANGELOG.md、README.md |
| 出力先 | docs/ |
| 文字コード | UTF-8 |
| 区切り文字 | なし（Markdown形式） |

## 処理フロー

### 処理シーケンス

```
1. ファイルコピー処理
   └─ CHANGELOG.mdをdocs/にコピー（既存ファイルは上書き）
   └─ README.mdをdocs/にコピー（既存ファイルは上書き）
2. ディレクトリコピー処理
   └─ images/ディレクトリをdocs/にコピー（既存ファイルは上書き）
3. Dockerログイン
   └─ docker login docker.pkg.github.comを実行
4. Dockerコンテナ起動
   └─ MkDocsイメージを起動し、現在のディレクトリを/docsにマウント
   └─ ポート8000でリッスン開始
5. ユーザー操作待機
   └─ ブラウザでhttp://localhost:8000にアクセス可能
   └─ Ctrl+Cでコンテナ終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[CHANGELOG.md/README.mdをdocsにコピー]
    B --> C[imagesディレクトリをdocsにコピー]
    C --> D[docker login実行]
    D --> E{ログイン成功?}
    E -->|成功| F[Dockerコンテナ起動]
    E -->|失敗| G[エラー終了]
    F --> H[ポート8000でリッスン]
    H --> I[ユーザー操作待機]
    I --> J[Ctrl+Cで終了]
    J --> K[コンテナ削除]
    K --> L[バッチ終了]
    G --> L
```

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

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

このバッチはデータベース操作を行いません。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| なし | - | - | データベース操作なし |

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

該当なし（データベース操作なし）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Dockerログインエラー | docker.pkg.github.comへの認証失敗 | GitHubトークンでdocker loginを実行 |
| - | ファイルコピーエラー | CHANGELOG.mdまたはREADME.mdが存在しない | ファイルの存在を確認 |
| - | ポート競合 | ポート8000が既に使用中 | 他のプロセスを停止するか、ポートを変更 |
| - | Dockerエラー | Dockerデーモンが起動していない | Dockerを起動 |

### リトライ仕様

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

### 障害時対応

1. Dockerログインエラーの場合：GitHubのPersonal Access Tokenを確認し、`docker login docker.pkg.github.com`を手動で実行してから再度バッチを実行
2. ポート競合の場合：`lsof -i :8000`でポート使用プロセスを確認し、停止してから再実行
3. Dockerエラーの場合：Docker Desktopまたはdockerdを起動してから再実行

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | なし（対話型処理） |
| 目標処理時間 | コンテナ起動まで10秒以内（初回イメージダウンロード時を除く） |
| メモリ使用量上限 | Dockerコンテナに依存 |

## 排他制御

同時実行は想定していません。同一マシンで複数回実行する場合、ポート8000が競合するため、前のコンテナを終了してから実行する必要があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | ファイルコピー時 | コピーされたファイル名 |
| 進捗ログ | Dockerログイン時 | ログイン結果 |
| 進捗ログ | コンテナ起動時 | MkDocsサーバーの起動メッセージ |
| エラーログ | エラー発生時 | Dockerまたはファイル操作のエラー詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| なし | - | - |

このバッチはローカル開発用ユーティリティのため、監視・アラートは設定されていません。

## 備考

- 使用するDockerイメージ：`docker.pkg.github.com/clojure-lsp/docs-image/docs-image`
- このイメージはMkDocsをベースとしたドキュメント生成環境を提供
- `-it`フラグにより対話型で実行され、Ctrl+Cで終了可能
- `--rm`フラグによりコンテナ終了時に自動削除
- 現在のディレクトリが`/docs`としてコンテナにマウントされるため、ファイル変更がリアルタイムで反映される
