# バッチ設計書 31-check.sh

## 概要

本ドキュメントは、NuGetパッケージ検証バッチ `check.sh` の設計仕様を記載したものです。このバッチは、パッケージの重複公開を防止するための検証処理を行います。

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

このバッチは、NuGetパッケージのリストアを実行し、その結果に基づいてパッケージが既に公開されているかどうかを検証します。

**業務上の目的・背景**：F#プロジェクトでは、NuGetパッケージを公開する際に、同一バージョンのパッケージが既に存在するかどうかを事前に確認する必要があります。既に公開済みのバージョンを再度公開しようとするとエラーが発生するため、このバッチを使用してビルドパイプラインの早い段階で問題を検出し、開発者にバージョン番号の更新を促します。

**バッチの実行タイミング**：CI/CDパイプラインでのパッケージ公開前、または手動でのパッケージ検証時に随時実行されます。

**主要な処理内容**：
1. 指定されたプロジェクトファイルに対して `dotnet restore` を実行
2. リストアの成否を確認（成功した場合はパッケージが既に公開されている）
3. Version.txt からパッケージバージョンを読み取り、エラーメッセージを出力
4. パッケージが既存の場合はエラー終了（exit 1）、存在しない場合は正常終了

**前後の処理との関連**：このバッチは通常、パッケージビルド処理の前に実行され、パッケージ公開の可否を判定します。後続のビルド・公開処理は、このバッチが正常終了した場合にのみ実行されます。

**影響範囲**：NuGetパッケージの公開可否判定に影響します。パッケージが既に公開されている場合、ビルドパイプラインが停止します。

## バッチ種別

パッケージ検証 / バリデーション

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | CI/CDパイプライン実行時 |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | CI/CD / 手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| dotnet CLI | .NET SDKがインストールされ、dotnetコマンドが使用可能であること |
| Version.txt | 作業ディレクトリにVersion.txtファイルが存在すること |
| プロジェクトファイル | 検証対象のプロジェクトファイルが存在すること |

### 実行可否判定

引数として1つのプロジェクトファイルパスが指定されていること。引数が指定されていない場合、または複数指定された場合はエラー終了します。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| project | string | Yes | - | 検証対象のプロジェクトファイルパス |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Version.txt | テキストファイル | 検証対象のパッケージバージョンが記載されたファイル |
| プロジェクトファイル | .csproj/.fsproj | NuGetパッケージ依存関係を定義するプロジェクトファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準エラー出力 | テキスト | エラーメッセージ（パッケージが既存の場合） |
| 終了コード | 数値 | 0: パッケージ未公開、1: パッケージ既存またはエラー |

### 出力ファイル仕様

本バッチはファイル出力を行いません。

## 処理フロー

### 処理シーケンス

```
1. 引数チェック
   └─ 引数が1つでない場合はUsageを表示してエラー終了
2. dotnet restore実行
   └─ 指定されたプロジェクトのNuGetパッケージリストアを実行
3. リストア結果判定
   └─ 成功（exit code 0）: パッケージが既に公開されている
   └─ 失敗（exit code != 0）: パッケージが未公開（期待動作）
4. 既存パッケージの場合
   └─ Version.txtからバージョン番号を取得
   └─ エラーメッセージを出力
   └─ exit 1で終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{引数が1つか？}
    B -->|No| C[Usage表示]
    C --> D[exit 1]
    B -->|Yes| E[dotnet restore 実行]
    E --> F{リストア成功？}
    F -->|Yes| G[Version.txt読み込み]
    G --> H[エラーメッセージ出力]
    H --> I[exit 1]
    F -->|No| J[正常終了 exit 0]
```

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

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

本バッチはデータベース操作を行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | 引数エラー | 引数が1つでない場合 | 正しい引数を指定して再実行 |
| 1 | パッケージ既存 | dotnet restoreが成功した場合 | Version.txtのバージョン番号を更新 |

### リトライ仕様

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

### 障害時対応

パッケージが既に公開されている場合は、Version.txtのバージョン番号をインクリメントして再度実行してください。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（外部コマンド実行のみ） |
| コミットタイミング | - |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1プロジェクト |
| 目標処理時間 | 30秒以内 |
| メモリ使用量上限 | dotnet restoreの要件に依存 |

## 排他制御

同時実行可能。ただし、同一プロジェクトに対する並行実行は、dotnet restoreのロック機構により制御されます。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| エラーログ | 引数不正時 | Usage情報 |
| エラーログ | パッケージ既存時 | パッケージバージョンとエラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 1 | CI/CDパイプライン |

## 備考

- 本バッチは「リストアが失敗すること」を期待する逆転ロジックを採用しています
- NuGetフィードへのネットワーク接続が必要です
- 標準エラー出力はdotnet restoreの出力を抑制（2>/dev/null）しています
