# バッチ設計書 15-snap.yml

## 概要

本ドキュメントは、GitHub Actions ワークフロー `snap.yml` の設計仕様を記載したバッチ設計書です。Snapパッケージのビルドを実行するワークフローの詳細を説明します。

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

このバッチは、GhosttyのSnapパッケージ（.snap形式）をビルドします。x86_64およびARM64アーキテクチャ向けのSnapパッケージを並列でビルドし、Linuxユーザーに配布可能な形式を生成します。workflow_dispatchトリガーのみをサポートし、他のワークフローから呼び出される形で実行されます。

**業務上の目的・背景**：Snapは、Canonicalが開発したLinux向けのパッケージ管理システムであり、Ubuntu及び多くのLinuxディストリビューションでサポートされています。Snapパッケージを提供することで、ユーザーは依存関係を気にせずGhosttyをインストールでき、自動更新も受けられます。本ワークフローは、リリースプロセスの一環としてSnapパッケージの自動ビルドを実現します。

**バッチの実行タイミング**：手動実行（workflow_dispatch）のみ。通常はリリースワークフロー（release-tag.yml等）から呼び出されます。ソースtarballのrun-idとartifact-idを入力パラメータとして受け取ります。

**主要な処理内容**：
1. ソースtarballアーティファクトのダウンロード
2. tarballの展開
3. キャッシュのセットアップ（/nix, /zig）
4. システム依存関係のインストール（udev）
5. LXD workaround の適用
6. snapcore/action-build によるSnapパッケージビルド

**前後の処理との関連**：build-distワークフローで生成されたソースtarballを前提条件とします。release-tag.ymlやrelease-tip.ymlから呼び出されることを想定しています。ビルド成果物は後続のリリース処理で使用されます。

**影響範囲**：GitHub Actionsのビルドアーティファクトとして.snapファイルが生成されます。本ワークフロー自体はストレージやデータベースに直接影響しません。

## バッチ種別

CI/CD / パッケージビルド

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（リリース時） |
| 実行時刻 | 指定なし |
| 実行曜日 | 指定なし |
| 実行日 | 指定なし |
| トリガー | 手動（workflow_dispatch） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| ソースtarball | build-distで生成されたghostty-source.tar.gzが存在すること |
| 有効なrun-id | ソースtarballを含むワークフロー実行のID |
| 有効なartifact-id | ダウンロード対象のアーティファクトID |

### 実行可否判定

入力パラメータ（source-run-id, source-artifact-id）が正しく指定されている必要があります。指定されたアーティファクトが存在しない場合はダウンロードステップで失敗します。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| source-run-id | string | Yes | なし | アーティファクトを生成したワークフロー実行のID |
| source-artifact-id | string | Yes | なし | ダウンロードするソースtarballのアーティファクトID |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| ghostty-source.tar.gz | tarball | ソースコードアーカイブ |
| GitHub Actions Artifacts | アーティファクト | 前段ワークフローの出力 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| GitHub Actions Artifacts | .snap | ビルドされたSnapパッケージ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | ghostty_*.snap |
| 出力先 | GitHub Actionsアーティファクト |
| 対象アーキテクチャ | x86_64, ARM64 |

## 処理フロー

### 処理シーケンス

```
1. アーティファクトダウンロード
   └─ 指定されたrun-id/artifact-idからソースtarballを取得
2. tarball展開
   └─ distディレクトリに展開（strip-components: 1）
3. キャッシュセットアップ
   └─ /nix, /zigディレクトリのキャッシュを復元
4. システム依存関係インストール
   └─ sudo apt install -y udev
5. systemd-udevd起動
   └─ sudo systemctl start systemd-udevd
6. LXD workaround適用
   └─ /var/lib/snapd/cgroup/snap.lxd.device設定
7. Snapビルド
   └─ snapcore/action-build でパッケージ生成
```

### フローチャート

```mermaid
flowchart TD
    A[ワークフロー開始] --> B[アーティファクトダウンロード]
    B --> C{ダウンロード成功?}
    C -->|失敗| D[エラー終了]
    C -->|成功| E[tarball展開]
    E --> F[キャッシュセットアップ]
    F --> G[udevインストール]
    G --> H[systemd-udevd起動]
    H --> I[LXD workaround適用]
    I --> J[Snapビルド実行]
    J --> K{ビルド成功?}
    K -->|失敗| L[エラー終了]
    K -->|成功| M[アーティファクト保存]
    M --> N[ワークフロー終了]
```

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

本ワークフローではデータベース操作は行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ダウンロード失敗 | アーティファクトが存在しない | run-id/artifact-idを確認 |
| - | ビルドエラー | Snapビルドプロセスの失敗 | ログを確認し問題を修正 |
| - | タイムアウト | ビルドが45分を超過 | ビルド設定を最適化 |

### リトライ仕様

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

### 障害時対応

1. GitHub Actions UIでエラーログを確認
2. アーティファクトの存在とIDを確認
3. Snapビルドエラーの場合はsnapcraft.yamlを確認
4. 必要に応じてワークフローを手動で再実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 2（x86_64, ARM64） |
| 目標処理時間 | 45分以内（timeout-minutes: 45） |
| メモリ使用量上限 | 指定なし |

## 排他制御

排他制御は設定されていません。マトリックスビルドにより、x86_64とARM64のビルドが並列で実行されます。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | ワークフロー開始時 | GitHub Actions標準ログ |
| 展開ログ | tarball展開時 | --verboseオプションによる詳細出力 |
| ビルドログ | Snapビルド時 | snapcraftの出力 |
| 終了ログ | ワークフロー終了時 | ジョブ完了ステータス |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ワークフロー失敗 | 1回 | GitHub通知 |
| ビルド時間 | 45分超過 | 自動タイムアウト |

## 備考

- マトリックスビルド: namespace-profile-ghostty-snap（x86_64）, namespace-profile-ghostty-snap-arm64（ARM64）
- fail-fast: false により、一方のアーキテクチャが失敗しても他方は継続
- LXD workaround: https://github.com/canonical/lxd-pkg-snap/pull/789 の問題に対応
- snapcore/action-build@v1.3.0 を使用
- actions/download-artifact@v8.0.0 を使用
- ZIG_LOCAL_CACHE_DIR: /zig/local-cache
- ZIG_GLOBAL_CACHE_DIR: /zig/global-cache
