go-review-kit

README

🤖 Go Review Kit

🚀 概要 (About)

Go Review Kit は、「Git の差分を取る → AI にレビューさせる → 結果を保存する → 通知する」を 1 本のパイプラインとして提供するライブラリです。main パッケージは持ちません。

レビュー結果は型付きの review.Report（判定・重大度付きの指摘）として受け渡し、 ParseReport / Validate で検証します。レビュアーの実体（単発の review.Reviewer / エージェント型の review.WorkspaceReviewer）は呼び出し側が差し込みます。AI SDK には 依存しないため、コードに限らず Markdown 原稿のレビューなど、実装次第で用途を変えられます。

扱わないこと

成果物の表現と保存先は呼び出し側の責務です。 JSON で残すのか、HTML に整形するのか、 GCS / S3 / DB のどこへ置くのかは review.Publisher の実装が決めます。表示の作りに従属する 決定なので、ライブラリ側に既定を持たせると利用側が要らないレンダリングと依存を抱えます。

同じ理由で、レビュアー（review.Reviewer / review.WorkspaceReviewer）・プロンプトの文面 （review.PromptGenerator）・通知先（review.Notifier）も呼び出し側が実装します。 どの AI SDK でレビューするかはアプリの選択であり、ライブラリが同梱すると全利用者が その SDK を抱えるためです。直接依存は go-git だけです。

---

🎯 特徴 (Key Features)

Git 操作

• 柔軟な参照解決: ブランチ名だけでなく、タグやコミットハッシュ（f921111 等）を直接 指定できます。
• 安全な解決順序: 常に「リモートブランチ → コミット」の順で解決します。数字だけの ブランチ名（チケット番号など）が短縮ハッシュとして解決され、意図しないコミットの差分を 取ってしまうのを防ぎます。
• 3 点比較: マージベースを起点にするため、base 側で進んだコミットが差分に混ざりません。

設計

• ヘキサゴナルアーキテクチャ: すべての結合は review パッケージのポート経由です。ポートは 1〜2 メソッドに絞ってあるため、テストのモックは数行で書けます。
• 工程が 1 階層: pipeline.Run が唯一の入口で、その下に中間層はありません。
• エラーは戻り値: 失敗は通常の error として返り、種類は番兵エラーで判別できます。
• レビュアーは 2 系統: 差分だけで完結する Reviewer と、Head をチェックアウトした 作業ディレクトリを自分で調べられる WorkspaceReviewer（エージェント型）です。実体は どちらも呼び出し側が提供し、pipeline.Deps にはどちらか一方だけを設定します。 モードごとに使い分けたい場合は、アダプターを共有した Pipeline を 2 つ組みます。

---

📂 プロジェクト構造 (Project Structure)

カテゴリ	パッケージ	役割と責務
契約	review	ドメイン型・番兵エラー・全ポートの定義。他のどのパッケージにも依存しません。
実行	pipeline	準備 → 差分 → プロンプト → (Head チェックアウト) → AI → 保存 → 通知 を制御し、結果を返します。
実装	git	review.DiffSource の実体。GoGit と CLI の 2 種類。どちらも WorkspaceProvider を満たします。

go-review-kit
├── review/          # 契約
│   ├── request.go   #   Request（Validate で検証、値として受け渡す）
│   ├── report.go    #   Report / Verdict / Finding / Severity / Decision
│   ├── result.go    #   Result / Status（SUCCESS / SKIPPED / FAILURE）
│   ├── errors.go    #   番兵エラーと StepError（工程名付きエラー）
│   └── ports.go     #   Reviewer / WorkspaceReviewer / DiffSource / Publisher / Notifier ほか
├── pipeline/        # 実行：Run(ctx, Request) (Result, *Report, error)
└── git/             # 実装：gogit.go / cli.go / refs.go / auth.go / factory.go

git の 2 実装の選び分け

どちらを使うかは呼び出し側が選びます（本ライブラリは選択しません）。

	GoGit	CLI
実体	go-git（純 Go）	ローカルの git コマンド
git バイナリ	不要	必要
Close の動作	作業ディレクトリごと削除	基準参照へ戻して未追跡ファイルを削除
向く環境	Cloud Run 等の使い捨て環境	チェックアウトを再利用できるローカル・CI

---

🧩 使い方 (Usage)

pipeline.Deps に実装を差し込んで Run を呼びます。

package main

import (
	"context"
	"log"

	"github.com/shouni/go-review-kit/git"
	"github.com/shouni/go-review-kit/pipeline"
	"github.com/shouni/go-review-kit/review"
)

// reviewer / publisher / notifier / prompts は呼び出し側の実装です。
// レビュアーの実装例（Gemini の構造化出力を review.ParseReport へ通す形）は
// 利用側リポジトリ adk-review の internal/adapters を参照してください。
func run(
	ctx context.Context,
	reviewer review.Reviewer,
	publisher review.Publisher,
	notifier review.Notifier,
	prompts review.PromptGenerator,
) error {
	sources, err := git.NewGoGitFactory("/var/tmp/reviews", git.WithSSHKey("~/.ssh/id_ed25519"))
	if err != nil {
		return err
	}

	p, err := pipeline.New(pipeline.Deps{
		Sources:   sources,
		Prompts:   prompts,
		Reviewer:  reviewer,
		Publisher: publisher,
		Notifier:  notifier,
	})
	if err != nil {
		return err
	}

	result, report, err := p.Run(ctx, review.Request{
		JobID:      "20260810-213000-a1b2c3d4", // 任意。相関ID
		RepoURL:    "ssh://git@github.com/shouni/example.git",
		Base:       "main",
		Head:       "develop",
		Mode:       "detail",
		Model:      "gemini-2.5-pro",
		StorageURI: "gs://bucket/reviews/20260810-213000-a1b2c3d4/report.json",
		PublicURL:  "https://example.com/history/20260810-213000-a1b2c3d4",
	})
	if err != nil {
		return err
	}

	// report はレビューが成立した場合のみ非 nil です。
	log.Printf("status=%s published=%v duration=%s findings=%d",
		result.Status, result.Published(), result.Duration, len(report.Findings))
	return nil
}

エラーの判別

工程名はエラー自身が持っているため、別のフィールドと突き合わせる必要はありません。

result, _, err := p.Run(ctx, req)
switch {
case errors.Is(err, review.ErrInvalidRequest):
	// 入力不備
case errors.Is(err, review.ErrRefNotFound):
	// ブランチ・コミットが見つからない
case err != nil:
	log.Printf("%s で失敗しました: %v", review.StepOf(err), err)
}

相関ID（JobID）

Request.JobID は呼び出し側が持つ相関IDです。本ライブラリは生成も解釈もせず、 Publisher / Notifier へそのまま渡し、ログ属性 job_id に載せるだけです。

ジョブ基盤を持つ呼び出し側が、成果物の保存先や進行状況の記録先を自分で決められるように するためのもので、書式も一意性も呼び出し側の責務です。未設定でも動作します。

---

📐 動作の約束 (Behavioural Contract)

呼び出し側が前提にしてよい取り決めです。

• 差分が無いのは失敗ではありません。 Run は StatusSkipped と nil を返します。成果物の 有無は Result.Published() で判別できます。
• Run はレビュー結果（*Report）も返します。 レビューが成立した場合のみ非 nil です。 保存に失敗した場合は Report が非 nil のままエラーも返るため、「レビューはできたが残せ なかった」を区別できます。レビューの中身を使う処理（ジョブ状態の記録など）は、Notifier を実装するのではなくこの戻り値から組み立ててください。
• Notifier は外向きの通知のためのものです。 呼び出し元の締切から切り離して呼ばれるので、 レビューが打ち切られた直後でも届きます。逆に言えば、その切り離しが要らない処理をここへ 載せる理由はありません。
• Publisher が呼ばれるのは成功時だけです。 差分なし・失敗のときは公開する内容が存在しない ため、Notifier だけが呼ばれます。
• Notifier は必ず 1 回呼ばれます。 成功・スキップ・失敗のいずれでも呼ばれ、保存に失敗した 場合も呼ばれます。報告がいちばん必要な場面で通知が飛ばない、という状態を作らないためです。
• 通知の失敗はパイプラインを失敗させません。 成果物は既に保存済みであり、不達を理由に結果を 失敗へ倒すと再実行の判断を誤らせるためです（記録は残ります）。
• 保存・通知・後始末は呼び出し元の締切から切り離されます。 レビューは重く、呼び出し元が タイムアウト付きの context を渡すことがあります。そのまま使うと、レビューが締切で打ち切られた 直後は context が期限切れなので、失敗を報告する通知や作業ディレクトリの後始末まで道連れで 失敗します。上限は pipeline.WithPublishTimeout で変更できます。
• WorkspaceReviewer が呼ばれる時点で、作業ツリーは Head の状態です。 Diff は作業ツリーに 触れずオブジェクト比較だけで差分を作るため、パイプラインがレビュー直前に WorkspaceProvider.CheckoutHead で明示的にチェックアウトします。この構成では DiffSourceFactory が返す DiffSource は review.WorkspaceProvider を満たす必要があります （git パッケージの 2 実装はどちらも満たします）。

---

🔄 シーケンスフロー (Sequence Flow)

sequenceDiagram
    participant App as Application (CLI/Web)
    participant PL as pipeline.Pipeline
    participant SF as DiffSourceFactory (git)
    participant DS as DiffSource
    participant PG as PromptGenerator (呼び出し側)
    participant AI as Reviewer or WorkspaceReviewer (呼び出し側)
    participant PB as Publisher (呼び出し側)
    participant NT as Notifier (呼び出し側)

    App->>PL: Run(ctx, Request)
    PL->>PL: Request.Validate()
    PL->>SF: Open(ctx, req)
    SF->>DS: clone / fetch
    SF-->>PL: DiffSource
    PL->>DS: Diff(ctx, base, head)
    DS-->>PL: patch

    alt 差分なし
        PL->>NT: Notify(StatusSkipped)
        PL-->>App: Result{SKIPPED}, nil, nil
    else 差分あり
        PL->>PG: Generate(mode, diff)
        PG-->>PL: prompt

        alt Reviewer 構成（単発）
            PL->>AI: Review(ctx, model, prompt)
        else WorkspaceReviewer 構成（エージェント型）
            PL->>DS: CheckoutHead(ctx, head)
            DS-->>PL: 作業ディレクトリ（Head の状態）
            PL->>AI: ReviewWorkspace(ctx, model, prompt, ws)
        end
        AI-->>PL: review.Report

        PL->>PB: Publish(ctx, req, report)
        PB-->>PL: ok
        PL->>NT: Notify(StatusSucceeded, Report)
        PL-->>App: Result{SUCCESS}, Report, nil
    end

    Note over PL,NT: Publish / Notify / Close は呼び出し元の締切から切り離して実行

---

🛠 開発 (Development)

go build ./...
go test -race ./...
go vet ./...
gofmt -l .

# Lint（CI と同じピン留めバージョン）
go run github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.12.2 run ./...

# 脆弱性チェック
go run golang.org/x/vuln/cmd/govulncheck@latest ./...

CI（.github/workflows/ci.yml）は main / develop への push と PR で、Build & Test・Lint・ govulncheck を別ジョブとして実行します。

---

📄 ライセンス (License)

MIT License. 詳細は LICENSE を参照してください。