# バッチ設計書 15-size-data.yml

## 概要

本ドキュメントは、GitHub Actionsによるビルドサイズデータ計測ワークフロー `.github/workflows/size-data.yml` のバッチ設計書である。push/PR時にビルドサイズデータを計測し、アーティファクトとしてアップロードする。

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

Vueパッケージのビルドサイズを計測し、結果データをGitHub Actionsアーティファクトとしてアップロードするワークフローである。main/minorブランチへのpushおよびPR時にトリガーされ、サイズデータを生成・保存する。PR時にはPR番号とベースブランチ情報もサイズデータと共に保存する。

**業務上の目的・背景**：Vueパッケージのバンドルサイズの変化を継続的に監視するため、push/PR時にサイズデータを自動計測する。このデータはsize-report.ymlワークフローで参照され、PRへのサイズ変化レポートのコメント投稿に使用される。バンドルサイズの増大はパフォーマンスに直結するため、早期検出が重要である。

**バッチの実行タイミング**：main/minorブランチへのpush時およびmain/minorブランチへのPR時に自動実行される。

**主要な処理内容**：
1. リポジトリのチェックアウトと開発環境のセットアップ
2. `pnpm run size` コマンドによるビルドサイズ計測の実行
3. PR時にはPR番号とベースブランチ名をテキストファイルとして保存
4. `temp/size` ディレクトリ配下のサイズデータをGitHub Actionsアーティファクトとしてアップロード

**前後の処理との関連**：本ワークフローの後続処理として `size-report.yml` が `workflow_run` トリガーで実行される。アップロードされたアーティファクト（size-data）はsize-report.ymlでダウンロードされ、サイズ比較レポートの生成に使用される。

**影響範囲**：GitHub Actionsアーティファクト（size-data）として保存されるサイズデータに影響する。vuejs/coreリポジトリでのみ実行される。

## バッチ種別

CI/CD（サイズ計測・データ収集）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | イベント駆動（push/PR時） |
| 実行時刻 | 指定なし（イベント発生時） |
| 実行曜日 | 指定なし |
| 実行日 | 指定なし |
| トリガー | push（main, minorブランチ）、pull_request（main, minorブランチ） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| GitHub Actionsランナー | ubuntu-latestが利用可能であること |
| permissions | contents: read が設定されていること |
| リポジトリ | vuejs/coreリポジトリであること |

### 実行可否判定

`github.repository == 'vuejs/core'` の場合のみ実行される。fork上では実行されない。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | ワークフロー入力パラメータなし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| ソースコード | Git | リポジトリの全ソースコード |
| .node-version | テキスト | Node.jsバージョン指定ファイル |
| github.event.number | 数値 | PR番号（PR時のみ） |
| github.base_ref | 文字列 | ベースブランチ名（PR時のみ） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| GitHub Actionsアーティファクト（size-data） | ファイル群 | temp/size配下のサイズデータ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | サイズデータ: pnpm run size の出力 / number.txt（PR番号） / base.txt（ベースブランチ） |
| 出力先 | temp/size/ |
| 文字コード | UTF-8 |
| 区切り文字 | なし（個別ファイル） |

## 処理フロー

### 処理シーケンス

```
1. チェックアウト（actions/checkout@v6）
2. pnpmインストール（pnpm/action-setup@v4.2.0）
3. Node.jsセットアップ（actions/setup-node@v6）
4. 依存関係インストール（pnpm install）
5. サイズ計測実行（pnpm run size）
6. PR情報保存（PR時のみ）
   ├─ PR番号を temp/size/number.txt に保存
   └─ ベースブランチ名を temp/size/base.txt に保存
7. アーティファクトアップロード（actions/upload-artifact@v6）
   └─ temp/size ディレクトリを size-data としてアップロード
```

### フローチャート

```mermaid
flowchart TD
    A[push/PR イベント] --> B{vuejs/core リポジトリ?}
    B -->|Yes| C[チェックアウト / セットアップ]
    B -->|No| Z[スキップ]
    C --> D[pnpm install]
    D --> E[pnpm run size]
    E --> F{PR イベント?}
    F -->|Yes| G[PR番号・ベースブランチ保存]
    F -->|No| H[アーティファクトアップロード]
    G --> H
    H --> I[ワークフロー完了]
    Z --> I
```

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

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

データベース操作なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ビルドサイズ計測失敗 | pnpm run sizeが失敗した場合 | ビルドエラーの原因を調査する |
| - | アーティファクトアップロード失敗 | upload-artifactが失敗した場合 | GitHub Actionsの状態を確認する |

### リトライ仕様

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

### 障害時対応

ワークフローを再実行する。サイズデータの計測自体は冪等であるため、再実行で問題が解消されることが多い。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1ジョブ |
| 目標処理時間 | GitHub Actionsの実行時間制限内 |
| メモリ使用量上限 | GitHub Actionsランナーのデフォルトリソースに依存 |

## 排他制御

明示的な排他制御設定なし。同一ブランチへの連続pushの場合は並行実行される可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| サイズ計測結果 | pnpm run size 完了時 | 各パッケージのビルドサイズ情報 |
| アップロード結果 | アップロード完了時 | アーティファクトのアップロードステータス |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ワークフロー実行結果 | 失敗時 | GitHubリポジトリの通知設定に依存 |

## 備考

- `PUPPETEER_SKIP_DOWNLOAD: 'true'` が環境変数レベルで設定されており、不要なChromiumダウンロードを抑制している
- PR情報の保存（number.txt, base.txt）は `github.event_name == 'pull_request'` 条件で制御されている
- pnpmのキャッシュが有効化されている（`cache: pnpm`）
- アーティファクト名は `size-data` で固定されており、size-report.ymlワークフローからこの名前で参照される
