# バッチ設計書 5-stats.yml

## 概要

本ドキュメントは、OpenCodeプロジェクトのダウンロード統計収集ワークフロー（stats.yml）の設計仕様を定義する。このバッチはGitHubリリースとnpmからダウンロード数を収集し、STATS.mdを更新する。

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

このバッチは、GitHubリリースアセットとnpm registryからダウンロード統計を日次で収集し、STATS.mdファイルに追記するGitHub Actionsワークフローである。収集したデータはPostHogにも送信され、分析に活用される。

**業務上の目的・背景**：ソフトウェアの普及状況を把握するため、ダウンロード数の継続的な追跡が必要である。GitHubリリースとnpmの両方からデータを収集することで、CLIインストールとnpmパッケージ利用の両方をカバーする。STATS.mdへの記録により、ダウンロード推移の可視化とトレンド分析が可能になる。

**バッチの実行タイミング**：毎日12:00 UTCにスケジュール実行される。手動でのworkflow_dispatchトリガーも可能。

**主要な処理内容**：
1. リポジトリをチェックアウト
2. Bun実行環境をセットアップ
3. stats.tsスクリプトを実行してダウンロード数を収集
4. 収集データをSTATS.mdに追記
5. 変更がある場合のみgit commit/pushを実行

**前後の処理との関連**：独立したバッチとして動作。stats.tsスクリプトを呼び出す。

**影響範囲**：STATS.mdファイルの更新、PostHogへのイベント送信に影響を与える。

## バッチ種別

データ収集 / 統計レポート生成

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 日次 |
| 実行時刻 | 12:00 UTC |
| 実行曜日 | 毎日 |
| 実行日 | 毎日 |
| トリガー | cron（0 12 * * *）、手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| リポジトリ | github.repository == 'anomalyco/opencode' |
| Bun | Bunランタイムが利用可能 |
| POSTHOG_KEY | PostHog APIキーがsecretsに設定（オプション） |
| contents: write | リポジトリへの書き込み権限 |

### 実行可否判定

github.repositoryが'anomalyco/opencode'の場合のみジョブが実行される。フォークリポジトリでは実行されない。

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| GitHub Releases API | JSON | リリースアセットのダウンロード数 |
| npm Downloads API | JSON | npmパッケージのダウンロード数 |
| STATS.md | マークダウン | 過去の統計データ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| STATS.md | マークダウン | 日次ダウンロード統計の追記 |
| PostHog | イベント | ダウンロードイベントデータ |
| git commit | コミット | 統計更新コミット |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | STATS.md |
| 出力先 | リポジトリルート |
| 文字コード | UTF-8 |
| フォーマット | マークダウンテーブル |

## 処理フロー

### 処理シーケンス

```
1. リポジトリチェックアウト
   └─ actions/checkout@v4

2. Bun環境セットアップ
   └─ .github/actions/setup-bun

3. 統計スクリプト実行
   └─ bun script/stats.ts
   ├─ GitHub Releases APIからダウンロード数取得
   ├─ npm Downloads APIからダウンロード数取得
   ├─ STATS.mdに追記
   └─ PostHogにイベント送信

4. コミット処理
   ├─ git config設定
   ├─ git add STATS.md
   ├─ 変更有無チェック（git diff --staged --quiet）
   └─ 変更がある場合のみコミット・プッシュ
```

### フローチャート

```mermaid
flowchart TD
    A[ワークフロー開始] --> B{リポジトリ確認}
    B -->|anomalyco/opencode| C[checkout]
    B -->|その他| Z[スキップ]
    C --> D[setup-bun]
    D --> E[bun script/stats.ts]
    E --> F[git config設定]
    F --> G[git add STATS.md]
    G --> H{変更あり?}
    H -->|Yes| I[git commit]
    I --> J[git push]
    H -->|No| K[スキップ]
    J --> L[ワークフロー終了]
    K --> L
    Z --> L
```

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

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

本ワークフローはデータベース操作を行わない。外部API（GitHub、npm、PostHog）へのリクエストのみ。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | API失敗 | GitHub/npm APIエラー | ネットワーク確認、API状態確認 |
| - | PostHog送信失敗 | APIキー不正 | POSTHOG_KEY確認 |
| - | コミット失敗 | git操作エラー | 権限確認 |

### リトライ仕様

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

### 障害時対応

1. スクリプト失敗：手動でstats.tsを実行して原因調査
2. コミット失敗：手動でSTATS.mdを更新・コミット
3. PostHog送信失敗：警告ログのみ出力、処理は継続

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | リリース数: 100件程度 |
| 目標処理時間 | 2分以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

concurrency設定により、同一ワークフロー・同一refの同時実行が防止される。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | スクリプト開始時 | "Fetching GitHub releases..." |
| 進捗ログ | ページ取得時 | "Fetched page {n} with {m} releases" |
| npm取得ログ | npm取得時 | "Fetching npm all-time downloads..." |
| 結果ログ | 処理完了時 | "TOTAL DOWNLOADS: {count}" |
| 更新ログ | ファイル更新時 | "Appended stats to STATS.md" |

## 監視・アラート

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

## 備考

- コミットメッセージは"ignore: update download stats {date}"形式で、changelogに含まれない
- 変更がない場合（git diff --staged --quiet成功）はコミットをスキップ
- PostHog APIキーが未設定の場合は警告ログを出力して続行
- Prettierでフォーマット整形後に保存
- GitHub APIはページング対応（per_page=100）
- npm APIは2020年からcurrentYear+5年までのデータを取得
