# バッチ設計書 13-sync-zed-extension.yml

## 概要

本ドキュメントは、GitHubリリース公開時にZed拡張機能を同期するワークフローの設計書です。zed-extensions/opencodeサブモジュールを更新してPRを作成します。

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

このバッチは、OpenCodeの新バージョンがリリースされた際に、Zedエディタの拡張機能リポジトリを自動的に同期し、バージョン更新のPull Requestを作成します。

**業務上の目的・背景**：OpenCodeはZedエディタの拡張機能としても提供されています。メインリポジトリのリリースと拡張機能リポジトリの同期を手動で行うと、作業漏れや遅延が発生する可能性があります。このバッチにより、リリースプロセスの一部として自動的にZed拡張機能を更新し、ユーザーへの迅速な機能提供を実現します。

**バッチの実行タイミング**：GitHubリリースが公開された時（release published）、または手動実行（workflow_dispatch）時に実行されます。

**主要な処理内容**：
1. リポジトリのチェックアウト（全履歴取得、fetch-depth: 0）
2. Bun環境のセットアップ
3. リリースタグの取得（イベントまたは最新タグから）
4. sync-zed.tsスクリプトの実行

**前後の処理との関連**：publish.ymlワークフローでリリースが作成された後に実行されます。script/sync-zed.tsスクリプトが実際の同期処理を担当します。

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

## バッチ種別

イベントドリブン / 外部リポジトリ連携 / リリース同期

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | リリース時（随時） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | release published / workflow_dispatch |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| ZED_EXTENSIONS_PAT | Zed拡張機能リポジトリへのアクセストークン |
| ZED_PR_PAT | PR作成用のアクセストークン |
| リリースタグ | 有効なバージョンタグが存在すること |

### 実行可否判定

- release publishedイベントまたはworkflow_dispatchで自動実行（条件分岐なし）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| github.event.release.tag_name | string | No | - | リリースイベント時のタグ名 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| GitHub Release | GitHub Event | 公開されたリリース情報 |
| Git Tags | Git | リポジトリのバージョンタグ |

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

ファイル出力はありません。外部リポジトリへのPR作成が出力となります。

## 処理フロー

### 処理シーケンス

```
1. イベント受信
   └─ release published または workflow_dispatch
2. 環境セットアップ
   └─ チェックアウト（全履歴）、Bunセットアップ
3. タグ取得
   └─ リリースイベントからタグ取得、または最新タグを検索
4. sync-zed.ts実行
   └─ スクリプトにタグを渡して同期処理実行
```

### フローチャート

```mermaid
flowchart TD
    A[イベント受信] --> B[チェックアウト]
    B --> C[Bunセットアップ]
    C --> D{イベント種別}
    D -->|release| E[リリースタグ取得]
    D -->|workflow_dispatch| F[最新タグ検索]
    E --> G[sync-zed.ts実行]
    F --> G
    G --> H[PR作成]
    H --> I[終了]
```

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

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

本バッチはデータベースを直接操作しません。

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

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 認証エラー | PATが無効 | Secrets設定を確認 |
| - | タグ未検出 | バージョンタグなし | リリースタグを確認 |
| - | PR作成失敗 | 権限不足 | PATの権限を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | GitHub Actionsデフォルト設定に従う |
| リトライ間隔 | - |
| リトライ対象エラー | ネットワークエラー |

### 障害時対応

1. ワークフロー実行ログを確認
2. sync-zed.tsスクリプトを手動実行
3. 必要に応じて手動でPRを作成

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1件/実行 |
| 目標処理時間 | 300秒以内 |
| メモリ使用量上限 | GitHub Actionsランナー標準 |

## 排他制御

同時実行は想定されていません。リリースイベントは一度に1つのみ発生します。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | ワークフロー開始時 | タグ名 |
| 進捗ログ | 各ステップ完了時 | ステップ名、実行結果 |
| 終了ログ | ワークフロー終了時 | PR URL |
| エラーログ | エラー発生時 | エラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ワークフロー失敗 | 1回 | GitHub Actions通知 |

## 備考

- sync-zed.tsスクリプトは別途詳細設計書（17-sync-zed.ts）を参照
- フォークリポジトリ（anomalyco/zed-extensions）を経由してPRを作成
- 手動実行時は最新のセマンティックバージョンタグが使用される
