@sk8metal/michi-cli 0.10.1 → 0.12.0

package/docs/user-guide/testing-strategy.md

@@ -1,185 +0,0 @@
-# テスト戦略
-
-このドキュメントでは、michiを使用したプロジェクトでの総合的なテスト戦略について説明します。
-
-## michiのテスト方針
-
-michiは、テスト駆動開発（TDD）と段階的なテスト実行（Phase A/B）を組み合わせたテスト戦略を採用しています。
-
-### 基本原則
-
-1. **テストファーストアプローチ**: コードを書く前にテストを書く（TDD）
-2. **段階的テスト実行**: PR前（Phase A）とリリース前（Phase B）で異なるテストを実行
-3. **自動化の推進**: Phase Aは完全自動化、Phase Bは計画的な手動実行
-4. **マスタテスト管理**: テストは常に最新の仕様を反映
-
-## テスト実行の2つのフェーズ
-
-| フェーズ | タイミング | 実行方式 | テストタイプ |
-|---------|----------|---------|------------|
-| **Phase A** | PR作成前 | CI/CD自動実行 | 単体テスト、Lint、ビルド |
-| **Phase B** | リリース準備時 | 手動実行 | 統合テスト、E2E、パフォーマンス、セキュリティ |
-
-詳細は [テスト実行フロー](./testing/test-execution-flow.md) を参照してください。
-
-## テスト計画から実行までの流れ
-
-```text
-Phase 0.3: テストタイプ選択
-    ↓
-Phase 0.4: テスト仕様書の作成
-    ↓
-Phase 0.5: タスク分割 (spec-tasks)
-    ↓
-Phase 0.6: タスクのJIRA同期
-    ↓
-Phase 1: 環境構築・基盤整備
-    ├─ テスト環境の準備
-    ├─ テストデータの準備
-    └─ テストディレクトリ構造の作成
-    ↓
-Phase 2: TDD実装（テストと実装を同時進行）
-    ↓
-Phase A: PR前の自動テスト（CI/CD）
-    ├─ 単体テスト
-    ├─ Lint
-    └─ ビルド
-    ↓
-[PRマージ]
-    ↓
-Phase 3: 追加の品質保証（PRマージ後）
-    ├─ 静的解析
-    ├─ セキュリティスキャン
-    └─ カバレッジ確認
-    ↓
-Phase B: リリース準備時の手動テスト
-    ├─ 統合テスト（推奨）
-    ├─ E2Eテスト（推奨）
-    ├─ パフォーマンステスト（任意）
-    └─ セキュリティテスト（任意）
-    ↓
-Phase 4-5: リリース準備・実行
-```
-
-### 各フェーズの詳細ドキュメント
-
-- **Phase 0.3〜Phase 1（テスト計画と環境整備）**: [テスト計画フロー](./testing/test-planning-flow.md)
-- **Phase 2（TDD実装）**: [TDDサイクル](./testing/tdd-cycle.md)
-- **Phase A/B実行**: [テスト実行フロー](./testing/test-execution-flow.md)
-- **Phase 3（追加QA）・テスト失敗時**: [テスト失敗時の対応](./testing/test-failure-handling.md)
-
-## テストタイプと選択基準
-
-| テストタイプ | 必須/任意 | 実行フェーズ | 選択基準 |
-|------------|---------|------------|---------|
-| 単体テスト | **必須** | Phase A | すべてのプロジェクト |
-| 統合テスト | **推奨** | Phase B | 複数コンポーネントが連携 |
-| E2Eテスト | **推奨** | Phase B | UIを持つアプリケーション |
-| パフォーマンステスト | 任意 | Phase B | 高負荷・レスポンスタイム重要 |
-| セキュリティテスト | 任意 | Phase B | 機密データ・外部公開API |
-
-### テスト仕様書テンプレート
-
-各テストタイプの仕様書テンプレートを用意しています：
-
-- [単体テスト仕様書テンプレート](./templates/test-specs/unit-test-spec-template.md)
-- [統合テスト仕様書テンプレート](./templates/test-specs/integration-test-spec-template.md)
-- [E2Eテスト仕様書テンプレート](./templates/test-specs/e2e-test-spec-template.md)
-- [パフォーマンステスト仕様書テンプレート](./templates/test-specs/performance-test-spec-template.md)
-- [セキュリティテスト仕様書テンプレート](./templates/test-specs/security-test-spec-template.md)
-
-## 対応言語とツール
-
-### Node.js / TypeScript
-- テストフレームワーク: Vitest
-- Lint: ESLint
-- ビルド: tsc
-
-### Java
-- テストフレームワーク: JUnit 5
-- ビルドツール: Gradle
-- Lint: Checkstyle
-
-### PHP
-- テストフレームワーク: PHPUnit
-- Lint: PHPStan
-- パッケージ管理: Composer
-
-## CI/CD連携
-
-Phase Aのテスト（単体テスト、Lint、ビルド）は、以下のCI/CDツールで自動実行されます：
-
-- GitHub Actions
-- Screwdriver
-
-詳細は [CI/CD設定](./release/ci-setup.md) を参照してください。
-
-## リリースフロー
-
-```text
-[開発完了]
-    ↓
-Phase A: 単体テスト + Lint + ビルド（自動）
-    ↓
-[PR作成・レビュー・マージ]
-    ↓
-Phase B: 統合 + E2E + その他（手動）
-    ↓
-[リリースタグ作成]
-    ↓
-CI/CD実行（自動）
-    ↓
-[GitHub Release作成]
-```
-
-詳細は [リリースフロー](./release/release-flow.md) を参照してください。
-
-## クイックスタートガイド
-
-### 1. 新規プロジェクトでmichiを導入する場合
-
-1. [テスト計画フロー](./testing/test-planning-flow.md) でテストタイプを選択
-2. テスト仕様書テンプレートを使用してテスト計画を作成
-3. [TDDサイクル](./testing/tdd-cycle.md) に従ってテストコードを実装
-4. [CI/CD設定](./release/ci-setup.md) でPhase Aを自動化
-5. [テスト実行フロー](./testing/test-execution-flow.md) に従って開発
-
-### 2. 既存プロジェクトにmichiを導入する場合
-
-1. 既存のテストをmichiのディレクトリ構造に移行
-2. Phase A（単体テスト）から段階的に自動化
-3. CI/CD設定を追加
-4. Phase B（統合テスト等）を計画的に追加
-
-## よくある質問
-
-### Q1: Phase Bのテストは毎回実行する必要がありますか？
-
-A: Phase Bはリリース前のみ実行します。毎PRで実行する必要はありません。
-
-### Q2: テストカバレッジの目標は？
-
-A: 単体テストで95%以上を推奨します。最低でも80%以上を目指してください。
-
-### Q3: パフォーマンステストやセキュリティテストは必須ですか？
-
-A: 必須ではありません。プロジェクトの要件に応じて選択してください。
-
-### Q4: Phase Bで問題が見つかったらどうすれば？
-
-A: バグ修正のPRを作成し、Phase Aを通過させてからマージ、Phase Bを再実行します。
-
-## 関連ドキュメント
-
-### テスト関連
-- [テスト計画フロー](./testing/test-planning-flow.md) - Phase 0.3〜Phase 1
-- [TDDサイクル](./testing/tdd-cycle.md) - Phase 2: RED-GREEN-REFACTOR
-- [テスト実行フロー](./testing/test-execution-flow.md) - Phase A/B/3
-- [テスト失敗時の対応](./testing/test-failure-handling.md) - トラブルシューティング
-
-### リリース関連
-- [リリースフロー](./release/release-flow.md) - タグ作成からリリースまで
-- [CI/CD設定](./release/ci-setup.md) - GitHub Actions/Screwdriver
-
-### テンプレート
-- [テスト仕様書テンプレート](./templates/test-specs/) - 各テストタイプ

package/docs/verification-guide.md

@@ -1,518 +0,0 @@
-# 新規実装機能 動作確認手順書
-
-このドキュメントでは、新規実装した3つの機能の動作確認手順を説明します。
-
-## 📋 目次
-
-1. [事前準備](#事前準備)
-2. [機能1: テスト実行とレポート生成](#機能1-テスト実行とレポート生成)
-3. [機能2: リリースノート生成](#機能2-リリースノート生成)
-4. [機能3: Confluence承認状態ポーリング](#機能3-confluence承認状態ポーリング)
-5. [統合テスト: ワークフロー実行](#統合テスト-ワークフロー実行)
-6. [トラブルシューティング](#トラブルシューティング)
-
----
-
-## 事前準備
-
-### 1. プロジェクトのビルド
-
-```bash
-npm run build
-```
-
-### 2. 必要なファイルの確認
-
-以下のファイルが存在することを確認してください:
-
-```bash
-# プロジェクトメタデータ
-ls -la .kiro/project.json
-
-# テスト用の機能仕様（既存）
-ls -la .kiro/specs/health-check-endpoint/
-```
-
-もし`.kiro/project.json`が存在しない場合は、以下のコマンドで作成できます:
-
-```bash
-cat > .kiro/project.json << 'EOF'
-{
-  "projectId": "michi",
-  "projectName": "Michi",
-  "jiraProjectKey": "MICHI",
-  "confluenceLabels": ["michi", "ai-development", "claude-code"],
-  "status": "active",
-  "team": ["Development Team"],
-  "stakeholders": ["Product Team", "Engineering Team"],
-  "repository": "https://github.com/sk8metalme/michi",
-  "description": "AI駆動開発を支援するプロジェクト管理・ドキュメント管理フレームワーク"
-}
-EOF
-```
-
----
-
-## 機能1: テスト実行とレポート生成
-
-### 概要
-
-プロジェクトの言語を自動検出し、適切なテストコマンドを実行してレポートを生成します。
-
-### 動作確認手順
-
-#### ステップ1: 単体テストを実行
-
-```bash
-# テスト確認スクリプトを実行
-node dist/scripts/test-new-features.js
-```
-
-#### ステップ2: 結果を確認
-
-コンソール出力で以下が表示されることを確認:
-
-```
-📋 Test 1: テスト実行とレポート生成
-============================================================
-
-✅ このプロジェクトでテストを実行します...
-
-📊 テスト結果:
-  ステータス: ✅ 成功
-  言語: Node.js/TypeScript
-  コマンド: npm test
-  実行時間: X.XX秒
-
-📝 レポート生成中...
-```
-
-### 期待される結果
-
-- ✅ テストが正常に実行される
-- ✅ テスト結果がMarkdown形式でフォーマットされる
-- ✅ 実行時間、タイムスタンプが記録される
-
-### 個別テスト（オプション）
-
-特定の言語でテストしたい場合:
-
-```typescript
-// test-runner-example.ts を作成
-import { executeTests, generateTestReport } from './dist/scripts/utils/test-runner.js';
-
-async function test() {
-  // Node.js/TypeScriptでテスト
-  const result = await executeTests('Node.js/TypeScript', process.cwd());
-  console.log('Result:', result);
-
-  // レポート生成
-  const report = generateTestReport(result, 'my-feature');
-  console.log('Report:', report);
-}
-
-test();
-```
-
-実行:
-```bash
-npx tsx test-runner-example.ts
-```
-
----
-
-## 機能2: リリースノート生成
-
-### 概要
-
-git logからコミット履歴を取得し、Conventional Commits形式でリリースノートを自動生成します。
-
-### 動作確認手順
-
-#### ステップ1: 単体テストを実行
-
-```bash
-# テスト確認スクリプトを実行
-node dist/scripts/test-new-features.js
-```
-
-#### ステップ2: 結果を確認
-
-コンソール出力で以下が表示されることを確認:
-
-```
-📋 Test 2: リリースノート生成
-============================================================
-
-✅ 最新10コミットを取得します...
-
-📊 取得したコミット数: 10
-
-最初の3コミット:
-  1. [feat] Claude Code/Claude AgentにkiroコードレビューとPR確認を追加
-  2. [feat] kiro:spec-implにコードレビューとPR作成確認を追加
-  3. [feat] Kiro spec-impl統合ワークフローと関連機能を追加
-
-📝 リリースノート生成中...
-```
-
-### 期待される結果
-
-- ✅ コミット履歴が正常に取得される
-- ✅ Conventional Commits形式が正しく解析される
-- ✅ Features, Bug Fixes, Other Changesに分類される
-- ✅ Markdown形式でリリースノートが生成される
-
-### 個別テスト（オプション）
-
-カスタムバージョンでリリースノートを生成:
-
-```typescript
-// release-notes-example.ts を作成
-import { createReleaseNotes } from './dist/scripts/utils/release-notes-generator.js';
-import { writeFileSync } from 'fs';
-
-async function test() {
-  // v2.0.0のリリースノートを生成
-  const notes = await createReleaseNotes('v2.0.0', 'HEAD~20', process.cwd());
-
-  // ファイルに保存
-  writeFileSync('RELEASE_NOTES_v2.0.0.md', notes, 'utf-8');
-  console.log('✅ リリースノート生成完了: RELEASE_NOTES_v2.0.0.md');
-  console.log(notes);
-}
-
-test();
-```
-
-実行:
-```bash
-npx tsx release-notes-example.ts
-```
-
----
-
-## 機能3: Confluence承認状態ポーリング
-
-### 概要
-
-Confluence APIを使用してページの承認状態を確認します。
-
-### 事前準備: 環境変数の設定
-
-Confluence APIを使用するため、以下の環境変数を設定してください:
-
-```bash
-# .envファイルに追加
-cat >> .env << 'EOF'
-
-# Confluence承認状態テスト用
-ATLASSIAN_URL=https://your-domain.atlassian.net
-ATLASSIAN_EMAIL=your-email@example.com
-ATLASSIAN_API_TOKEN=your-api-token
-CONFLUENCE_TEST_PAGE_ID=123456
-EOF
-```
-
-**API Token取得方法:**
-1. Atlassianアカウントにログイン
-2. https://id.atlassian.com/manage-profile/security/api-tokens にアクセス
-3. 「Create API token」をクリック
-4. トークンをコピーして`ATLASSIAN_API_TOKEN`に設定
-
-**ページIDの確認方法:**
-1. Confluenceページを開く
-2. URLから`pageId=XXXXXX`の部分を確認
-   - 例: `https://your-domain.atlassian.net/wiki/spaces/SPACE/pages/123456/PageTitle`
-   - この場合、ページIDは`123456`
-
-### 動作確認手順
-
-#### ステップ1: 環境変数が設定されていることを確認
-
-```bash
-echo "URL: $ATLASSIAN_URL"
-echo "Email: $ATLASSIAN_EMAIL"
-echo "Page ID: $CONFLUENCE_TEST_PAGE_ID"
-```
-
-#### ステップ2: テストを実行
-
-```bash
-node dist/scripts/test-new-features.js
-```
-
-#### ステップ3: 結果を確認
-
-環境変数が設定されている場合:
-
-```
-📋 Test 3: Confluence承認状態確認
-============================================================
-
-✅ Confluence承認状態を確認します...
-
-📊 承認状態:
-  ページID: 123456
-  ページタイトル: Test Page
-  承認済み: ✅ はい / ❌ いいえ
-  承認者: user1, user2
-```
-
-環境変数が未設定の場合:
-
-```
-⚠️  Confluence認証情報が設定されていません
-   以下の環境変数を設定すると、実際のAPIテストが可能です:
-   - ATLASSIAN_URL
-   - ATLASSIAN_EMAIL
-   - ATLASSIAN_API_TOKEN
-   - CONFLUENCE_TEST_PAGE_ID (テスト用ページID)
-```
-
-### 期待される結果
-
-- ✅ Confluence APIに正常に接続できる
-- ✅ ページ情報が取得できる
-- ✅ 承認状態が正しく判定される
-
-### 個別テスト（オプション）
-
-```typescript
-// confluence-approval-example.ts を作成
-import { getApprovalStatus } from './dist/scripts/utils/confluence-approval.js';
-
-async function test() {
-  const config = {
-    url: process.env.ATLASSIAN_URL!,
-    email: process.env.ATLASSIAN_EMAIL!,
-    apiToken: process.env.ATLASSIAN_API_TOKEN!
-  };
-
-  const pageId = process.env.CONFLUENCE_TEST_PAGE_ID!;
-
-  const status = await getApprovalStatus(pageId, config);
-  console.log('承認状態:', status);
-}
-
-test();
-```
-
-実行:
-```bash
-npx tsx confluence-approval-example.ts
-```
-
----
-
-## 統合テスト: ワークフロー実行
-
-### 概要
-
-全機能を統合したワークフローとして実行します。
-
-### 動作確認手順
-
-#### ステップ1: testとreleaseステージのみを実行
-
-```bash
-npx tsx scripts/test-workflow-stages.ts --feature health-check-endpoint
-```
-
-#### ステップ2: 結果を確認
-
-```
-🧪 新規実装ステージのテスト
-Feature: health-check-endpoint
-Stages: test → release
-
-🚀 Starting workflow for: health-check-endpoint
-Stages: test → release
-Project: Michi
-
-📋 Stage: test
-  Test phase - execute tests
-  Detected language: Node.js/TypeScript (medium confidence)
-  Running tests...
-  ✅ Test report saved: .kiro/specs/health-check-endpoint/test-report.md
-✅ Stage completed: test
-
-📋 Stage: release
-  Release preparation
-  Generating release notes for v1.0.0...
-  ✅ Release notes saved: .kiro/specs/health-check-endpoint/release-notes-v1.0.0.md
-✅ Stage completed: release
-
-🎉 Workflow completed successfully!
-```
-
-#### ステップ3: 生成されたファイルを確認
-
-```bash
-# テストレポートを表示
-cat .kiro/specs/health-check-endpoint/test-report.md
-
-# リリースノートを表示
-cat .kiro/specs/health-check-endpoint/release-notes-v1.0.0.md
-```
-
-### 期待される結果
-
-- ✅ testステージが正常に完了する
-- ✅ releaseステージが正常に完了する
-- ✅ テストレポートが生成される
-- ✅ リリースノートが生成される
-
-### カスタムバージョンでテスト
-
-```bash
-# バージョンを指定
-RELEASE_VERSION=v2.1.0 npx tsx scripts/test-workflow-stages.ts --feature health-check-endpoint
-
-# 生成されたファイルを確認
-cat .kiro/specs/health-check-endpoint/release-notes-v2.1.0.md
-```
-
----
-
-## トラブルシューティング
-
-### Q1. テスト実行が失敗する
-
-**症状:**
-```
-❌ Test execution failed: Command failed: npm test
-```
-
-**解決方法:**
-1. 依存関係を再インストール
-   ```bash
-   npm clean-install
-   ```
-
-2. ビルドを実行
-   ```bash
-   npm run build
-   ```
-
-3. テストを直接実行して確認
-   ```bash
-   npm test
-   ```
-
----
-
-### Q2. リリースノート生成でコミットが見つからない
-
-**症状:**
-```
-📊 取得したコミット数: 0
-⚠️  コミットが見つかりませんでした
-```
-
-**解決方法:**
-1. gitリポジトリであることを確認
-   ```bash
-   git status
-   ```
-
-2. コミット履歴を確認
-   ```bash
-   git log --oneline | head -10
-   ```
-
-3. 範囲を調整
-   ```typescript
-   // より広い範囲で取得
-   const commits = await getCommits('HEAD~50', 'HEAD', process.cwd());
-   ```
-
----
-
-### Q3. Confluence API接続エラー
-
-**症状:**
-```
-❌ Confluence承認状態確認エラー: Request failed with status code 401
-```
-
-**解決方法:**
-1. 環境変数を確認
-   ```bash
-   cat .env | grep ATLASSIAN
-   ```
-
-2. API Tokenを再生成
-   - https://id.atlassian.com/manage-profile/security/api-tokens
-
-3. 接続テスト
-   ```bash
-   curl -u "$ATLASSIAN_EMAIL:$ATLASSIAN_API_TOKEN" \
-     "$ATLASSIAN_URL/wiki/rest/api/content/$CONFLUENCE_TEST_PAGE_ID"
-   ```
-
----
-
-### Q4. ワークフローが途中で停止する
-
-**症状:**
-```
-❌ Stage failed: test Command failed: npm test
-```
-
-**解決方法:**
-1. ログを確認
-   ```bash
-   # 詳細ログを有効化
-   DEBUG=* npx tsx scripts/test-workflow-stages.ts --feature health-check-endpoint
-   ```
-
-2. ステージごとに個別テスト
-   ```bash
-   # テストステージのみ
-   node dist/scripts/test-new-features.js
-   ```
-
-3. エラーメッセージを確認して対処
-
----
-
-## 📊 チェックリスト
-
-動作確認完了の確認に使用してください:
-
-### 基本動作
-- [ ] ビルドが成功する（`npm run build`）
-- [ ] 全テストがパスする（`npm test`）
-- [ ] `.kiro/project.json`が存在する
-
-### 機能1: テスト実行とレポート生成
-- [ ] テストが正常に実行される
-- [ ] レポートがMarkdown形式で生成される
-- [ ] 実行時間が記録される
-
-### 機能2: リリースノート生成
-- [ ] コミット履歴が取得できる
-- [ ] Conventional Commits形式が解析される
-- [ ] リリースノートが生成される
-
-### 機能3: Confluence承認状態
-- [ ] 環境変数が設定されている（オプション）
-- [ ] Confluence APIに接続できる（オプション）
-- [ ] 承認状態が取得できる（オプション）
-
-### 統合テスト
-- [ ] testステージが成功する
-- [ ] releaseステージが成功する
-- [ ] 生成ファイルが正しい場所に保存される
-
----
-
-## 📝 まとめ
-
-すべてのチェック項目が完了したら、新規実装機能の動作確認は完了です。
-
-ご不明な点がありましたら、以下を確認してください:
-- 実装コード: `scripts/utils/test-runner.ts`, `release-notes-generator.ts`, `confluence-approval.ts`
-- テストコード: `scripts/utils/__tests__/test-runner.test.ts`
-- 統合スクリプト: `scripts/test-new-features.ts`, `scripts/test-workflow-stages.ts`