# バッチ設計書 17-sync-zed.ts

## 概要

本ドキュメントは、Zed拡張機能リポジトリを同期してPRを作成するスクリプトの設計書です。フォークをアップストリームと同期し、バージョン更新PRを作成します。

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

このスクリプトは、OpenCodeのリリースバージョンに合わせてZedエディタ拡張機能リポジトリを更新し、公式リポジトリへのPull Requestを自動作成します。GitHub Actionsワークフロー（sync-zed-extension.yml）から呼び出されます。

**業務上の目的・背景**：Zedエディタの拡張機能はzed-industries/extensionsリポジトリで管理されています。OpenCodeのバージョンアップ時に、このリポジトリのサブモジュールとバージョン情報を更新する必要があります。このスクリプトにより、フォークの同期からPR作成までを完全自動化し、リリースプロセスの一部として確実に拡張機能を更新できます。

**バッチの実行タイミング**：sync-zed-extension.ymlワークフローから呼び出されます。リリース公開時または手動実行時に起動します。

**主要な処理内容**：
1. バージョン引数の検証とコミットSHA取得
2. extension.tomlのバージョン整合性チェック
3. フォークリポジトリのクローンとアップストリーム同期（force reset）
4. 更新ブランチ作成とサブモジュール更新
5. extensions.tomlのバージョン更新
6. 古い更新ブランチの削除
7. 新ブランチのプッシュとPR作成

**前後の処理との関連**：publish.ymlでリリースが作成された後、sync-zed-extension.ymlから呼び出されます。PRは外部のzed-industries/extensionsリポジトリに作成されます。

**影響範囲**：anomalyco/zed-extensionsフォークリポジトリ、zed-industries/extensions外部リポジトリ

## バッチ種別

外部リポジトリ連携 / Git操作 / PR自動作成

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | リリース時（随時） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | ワークフローからの呼び出し |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| バージョン引数 | 有効なバージョンタグ（例：v1.0.52） |
| ZED_EXTENSIONS_PAT | フォークリポジトリ操作用トークン |
| ZED_PR_PAT | PR作成用トークン |
| ghコマンド | GitHub CLIがインストールされていること |

### 実行可否判定

- バージョン引数が必須
- extension.tomlのバージョンとタグの一致が必須

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| version | string | Yes | - | バージョンタグ（例：v1.0.52） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Gitタグ | Git | バージョンタグとコミットSHA |
| extension.toml | TOML | 拡張機能のバージョン定義 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| anomalyco/zed-extensions | Git Branch | 更新ブランチ |
| zed-industries/extensions | GitHub PR | バージョン更新PR |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| 更新対象 | extensions.toml（バージョン番号更新） |
| サブモジュール | extensions/opencode（コミット参照更新） |

## 処理フロー

### 処理シーケンス

```
1. 引数検証
   └─ バージョン引数の存在確認、環境変数チェック
2. バージョン検証
   └─ タグからコミットSHA取得、extension.tomlのバージョン一致確認
3. フォーククローン
   └─ 一時ディレクトリにanomalyco/zed-extensionsをクローン
4. アップストリーム同期
   └─ zed-industries/extensionsとforce reset同期
5. ブランチ作成
   └─ update-opencode-{version}ブランチ作成
6. サブモジュール更新
   └─ extensions/opencodeサブモジュールを指定コミットに更新
7. extensions.toml更新
   └─ バージョン番号を正規表現で置換
8. コミット
   └─ 変更をコミット
9. 古いブランチ削除
   └─ 既存のupdate-opencode-*ブランチを削除
10. プッシュ・PR作成
    └─ フォークにプッシュ、アップストリームへPR作成
```

### フローチャート

```mermaid
flowchart TD
    A[スクリプト開始] --> B[引数・環境変数検証]
    B --> C[コミットSHA取得]
    C --> D[extension.tomlバージョン検証]
    D --> E{バージョン一致?}
    E -->|No| F[エラー終了]
    E -->|Yes| G[フォーククローン]
    G --> H[アップストリーム同期]
    H --> I[更新ブランチ作成]
    I --> J[サブモジュール更新]
    J --> K[extensions.toml更新]
    K --> L[変更コミット]
    L --> M[古いブランチ削除]
    M --> N[フォークへプッシュ]
    N --> O[gh pr create実行]
    O --> P[PR URL出力]
    P --> Q[終了]
```

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

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

本スクリプトはデータベースを操作しません。

| 処理 | 対象 | 操作種別 | 概要 |
|-----|------|---------|------|
| ブランチ作成 | anomalyco/zed-extensions | Git Push | 更新ブランチ作成 |
| ブランチ削除 | anomalyco/zed-extensions | Git Push --delete | 古いブランチ削除 |
| PR作成 | zed-industries/extensions | GitHub API | バージョン更新PR |

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 引数エラー | バージョン引数なし | 引数を指定して再実行 |
| - | 環境変数エラー | PATが未設定 | 環境変数を設定 |
| - | バージョン不一致 | extension.tomlとタグの不一致 | バージョンを修正 |
| - | Git操作エラー | ネットワークエラー | 再実行 |
| - | PR作成エラー | 権限不足 | トークン権限を確認 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認
2. 一時ディレクトリのクリーンアップ
3. 問題解決後、再実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | スクリプト全体 |
| コミットタイミング | PR作成完了時 |
| ロールバック条件 | エラー発生時は変更なし（プッシュ前） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1リポジトリ/実行 |
| 目標処理時間 | 180秒以内 |
| メモリ使用量上限 | 標準的なNode.jsプロセス |

## 排他制御

同時実行は想定されていません。古いブランチの削除処理により、競合を防止します。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | 各ステップ | 絵文字付きステータスメッセージ |
| 成功ログ | 処理完了時 | PR URL |
| エラーログ | エラー発生時 | エラーメッセージ |

## 監視・アラート

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

ワークフローから呼び出されるため、ワークフローレベルで監視されます。

## 備考

- shebang行（`#!/usr/bin/env bun`）により、`./script/sync-zed.ts v1.0.52`として直接実行可能
- FORK_REPO: anomalyco/zed-extensions
- UPSTREAM_REPO: zed-industries/extensions
- EXTENSION_NAME: opencode
- フォークは毎回アップストリームにforce resetされる（クリーンな状態を維持）
- gh pr createコマンドでPRを作成、.nothrow()でエラーをキャッチ
- Git設定（user.name, user.email）はスクリプト内で設定
