# バッチ設計書 24-scripts/revert_publish.sh

## 概要

本ドキュメントは、Decap CMSプロジェクトにおけるLernaパブリッシュのrevert（巻き戻し）を行うシェルスクリプト `scripts/revert_publish.sh` の設計を記述する。

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

本スクリプトは、Lernaによるパブリッシュコミットとそれに関連するGitタグを削除し、リリースを巻き戻すためのシェルスクリプトである。誤ったリリースやリリース後の問題発覚時に、Gitリポジトリの状態をパブリッシュ前に戻すために使用する。

**業務上の目的・背景**：Lernaによるパッケージ公開後に、重大なバグや誤った変更が含まれていたことが判明した場合、迅速にリリースを巻き戻す必要がある。本スクリプトは、パブリッシュコミットの特定、関連タグの削除、コミットのrevert、mainブランチへのpushを自動化し、手作業による巻き戻し操作のミスを防止する。npmレジストリからのunpublishは本スクリプトの範囲外である。

**バッチの実行タイミング**：手動実行。Lernaパブリッシュ後に問題が発覚した場合の緊急対応として実行される。

**主要な処理内容**：
1. Gitログから `chore(release): publish` コミットメッセージに一致する直近のコミットハッシュを取得
2. 取得したコミットに付与されているGitタグを特定
3. リモートリポジトリからタグを削除（`git push --delete origin`）
4. パブリッシュコミットをrevert（`git revert --no-edit`）
5. revertコミットをmainブランチにpush

**前後の処理との関連**：本スクリプトは `lerna:publish`（No.17）によるパブリッシュ処理の逆操作である。Lernaのバージョン管理設定（`lerna.json`）で定義されたコミットメッセージ `chore(release): publish` を基にパブリッシュコミットを特定する。npmレジストリからのパッケージ削除は別途手動で行う必要がある。

**影響範囲**：mainブランチのGit履歴（revertコミットの追加）、リモートリポジトリのタグ、CI/CDパイプライン（タグ削除によるリリースワークフローへの影響）。

## バッチ種別

ユーティリティ（リリース巻き戻し）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（緊急対応時の手動実行） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動（`./scripts/revert_publish.sh`） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Gitリポジトリ | Gitリポジトリ内で実行すること |
| リモートリポジトリへのアクセス権 | originリモートへのpush権限があること |
| パブリッシュコミットの存在 | `chore(release): publish` というメッセージのコミットがGitログに存在すること |
| mainブランチ | mainブランチにチェックアウトしていること |
| クリーンなワーキングツリー | 未コミットの変更がないこと |

### 実行可否判定

Gitログに `chore(release): publish` コミットが存在しない場合、コミットハッシュが空となり後続のgit操作が失敗する。明示的な事前チェックは実装されていない。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| N/A | - | - | - | 本スクリプトは入力パラメータを受け取らない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Gitログ | Git履歴 | `chore(release): publish` メッセージのコミットを検索 |
| Gitタグ | Gitタグ | パブリッシュコミットに付与されたタグを取得 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| Gitリポジトリ（ローカル） | Gitコミット | revertコミットの追加 |
| Gitリポジトリ（リモート） | Gitコミット/タグ | revertコミットのpush、タグの削除 |

### 出力ファイル仕様

本スクリプトはファイル出力を行わない。Git操作のみ。

| 項目 | 内容 |
|-----|------|
| ファイル名 | N/A |
| 出力先 | N/A |
| 文字コード | N/A |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. パブリッシュコミットの特定
   └─ git log -1 --pretty=format:"%H" --grep="^chore(release): publish$" で直近のパブリッシュコミットハッシュを取得
2. 関連タグの取得
   └─ git tag -l --points-at {コミットハッシュ} でコミットに紐づくタグを取得
3. リモートタグの削除
   └─ git push --delete origin {タグ} でリモートリポジトリからタグを削除
4. コミットのrevert
   └─ git revert --no-edit {コミットハッシュ} でパブリッシュコミットを取り消すrevertコミットを作成
5. リモートへのpush
   └─ git push origin main でrevertコミットをリモートに反映
```

### フローチャート

```mermaid
flowchart TD
    A[スクリプト開始] --> B["git log でパブリッシュコミットハッシュ取得"]
    B --> C["git tag でコミットに紐づくタグ取得"]
    C --> D["git push --delete origin でタグ削除"]
    D --> E["git revert --no-edit でコミットrevert"]
    E --> F["git push origin main"]
    F --> G[スクリプト終了]
```

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

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

本スクリプトはデータベース操作を行わない。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | データベース操作なし |

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

N/A

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | コミット不在エラー | `chore(release): publish` コミットがログに存在しない | Gitログを確認し、正しいブランチで実行する |
| N/A | タグ削除エラー | リモートタグが既に削除されている | 手動でタグ状態を確認する |
| N/A | revert競合エラー | revert時にコンフリクトが発生 | 手動でコンフリクトを解消する |
| N/A | push拒否エラー | mainブランチへのpush権限がない、またはブランチ保護 | リポジトリ設定を確認し権限を付与する |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | N/A（リトライ機構なし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

スクリプトが途中で失敗した場合、以下の順序で手動復旧を行う：
1. `git status` でローカルの状態を確認
2. revert途中であれば `git revert --abort` でrevertをキャンセル
3. 必要に応じてリモートのタグ状態を手動確認・削除
4. ワーキングツリーをクリーンにしてから再実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（Git操作は各コマンド単位で実行） |
| コミットタイミング | git revert実行時に自動コミット |
| ロールバック条件 | N/A（途中失敗時の自動ロールバックなし。手動で `git revert --abort` を実行） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1コミット+関連タグ |
| 目標処理時間 | 1分以内 |
| メモリ使用量上限 | 最小限（Git操作のみ） |

## 排他制御

同時実行は禁止。mainブランチへのpush操作を含むため、複数人が同時に実行するとコンフリクトが発生する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | パブリッシュコミット特定後 | `reverting publish commit {コミットハッシュ}` |
| 進捗ログ | タグ削除前 | `deleting tags {タグ}` |
| 進捗ログ | revert実行前 | `reverting commit {コミットハッシュ}` |
| 進捗ログ | push前 | `pushing changes` |
| 完了ログ | 処理完了時 | `done reverting publish` |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| N/A | N/A | 手動実行の緊急対応スクリプトのため監視対象外 |

## 備考

- Lernaの `lerna.json` でバージョンコミットメッセージが `chore(release): publish` に設定されていることが前提
- 本スクリプトはGitリポジトリの操作のみを行い、npmレジストリからのパッケージ削除（`npm unpublish`）は行わない
- 複数のタグがパブリッシュコミットに付与されている場合（独立バージョニングの場合）、全タグが一括削除される
- mainブランチへの直接pushが必要なため、ブランチ保護設定によっては管理者権限が必要
- `git revert --no-edit` を使用するため、revertコミットメッセージはGitのデフォルトメッセージが使用される
