@sk8metal/michi-cli 0.8.7 → 0.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. package/CHANGELOG.md +70 -1
  2. package/README.md +77 -847
  3. package/dist/scripts/config/config-schema.d.ts +3 -0
  4. package/dist/scripts/config/config-schema.d.ts.map +1 -1
  5. package/dist/scripts/config/config-schema.js +18 -0
  6. package/dist/scripts/config/config-schema.js.map +1 -1
  7. package/dist/scripts/phase-runner.js +1 -1
  8. package/dist/scripts/phase-runner.js.map +1 -1
  9. package/dist/scripts/utils/multi-repo-validator.d.ts +38 -1
  10. package/dist/scripts/utils/multi-repo-validator.d.ts.map +1 -1
  11. package/dist/scripts/utils/multi-repo-validator.js +166 -1
  12. package/dist/scripts/utils/multi-repo-validator.js.map +1 -1
  13. package/dist/scripts/utils/tasks-format-validator.js +3 -3
  14. package/dist/scripts/utils/tasks-format-validator.js.map +1 -1
  15. package/docs/README.md +20 -83
  16. package/docs/getting-started/configuration.md +379 -0
  17. package/docs/getting-started/installation.md +59 -0
  18. package/docs/getting-started/quick-start.md +76 -0
  19. package/docs/guides/ai-tools.md +311 -0
  20. package/docs/guides/atlassian-integration.md +116 -0
  21. package/docs/guides/claude-code.md +155 -0
  22. package/docs/guides/multi-repo.md +117 -0
  23. package/docs/guides/workflow.md +382 -0
  24. package/docs/reference/ai-commands.md +92 -0
  25. package/docs/reference/cli.md +756 -0
  26. package/docs/reference/environment-variables.md +192 -0
  27. package/docs/troubleshooting.md +543 -0
  28. package/package.json +1 -1
  29. package/scripts/__tests__/multi-repo-config-schema.test.ts +106 -0
  30. package/scripts/__tests__/multi-repo-validator.test.ts +229 -1
  31. package/scripts/config/config-schema.ts +20 -0
  32. package/scripts/phase-runner.ts +1 -1
  33. package/scripts/utils/__tests__/multi-repo-validator.test.ts +159 -1
  34. package/scripts/utils/multi-repo-validator.ts +210 -1
  35. package/scripts/utils/tasks-format-validator.ts +3 -3
  36. package/templates/claude/agents/e2e-first-planner/AGENT.md +1 -1
  37. package/templates/claude/agents/mermaid-validator/AGENT.md +257 -0
  38. package/templates/claude/agents/pr-resolver/AGENT.md +15 -3
  39. package/templates/claude/commands/michi/e2e-plan.md +1 -1
  40. package/templates/claude/commands/michi/spec-design.md +2 -2
  41. package/templates/claude/commands/michi/spec-tasks.md +156 -0
  42. package/templates/claude/commands/michi/test-planning.md +1 -1
  43. package/templates/claude/commands/michi/validate-design.md +3 -3
  44. package/templates/claude/commands/michi-multi-repo/impl-all.md +293 -0
  45. package/templates/claude/commands/michi-multi-repo/propagate-specs.md +284 -0
  46. package/templates/claude/commands/michi-multi-repo/spec-design.md +66 -3
  47. package/templates/claude/commands/michi-multi-repo/spec-review.md +261 -0
  48. package/templates/claude/skills/mermaid-validator/SKILL.md +261 -0
  49. package/templates/claude-agent/agents/cross-repo-reviewer.md +194 -0
  50. package/templates/claude-agent/agents/repo-spec-executor.md +113 -0
  51. package/templates/claude-agent/commands/michi/spec-tasks.md +117 -0
  52. package/templates/claude-agent/rules/code-size-monitor.md +26 -0
  53. package/templates/claude-agent/rules/code-size-rules.md +32 -0
  54. package/templates/codex/AGENTS.override.md +1 -1
  55. package/templates/codex/rules/README.md +2 -2
  56. package/templates/cursor/commands/michi/spec-tasks.md +117 -0
  57. package/templates/michi/cc-sdd-overrides/settings/rules/design-review-michi.md +1 -1
  58. package/docs/context.md +0 -59
  59. package/docs/michi-development/contributing/development.md +0 -341
  60. package/docs/michi-development/contributing/release.md +0 -365
  61. package/docs/michi-development/design/config-unification.md +0 -733
  62. package/docs/michi-development/design/design-config-current-state.md +0 -330
  63. package/docs/michi-development/design/design-config-implementation.md +0 -628
  64. package/docs/michi-development/design/design-config-migration.md +0 -952
  65. package/docs/michi-development/design/design-config-security.md +0 -771
  66. package/docs/michi-development/design/design-config-solution.md +0 -583
  67. package/docs/michi-development/design/design-config-testing.md +0 -892
  68. package/docs/michi-development/testing/manual-verification-flow.md +0 -871
  69. package/docs/michi-development/testing/manual-verification-other-tools.md +0 -1279
  70. package/docs/michi-development/testing/manual-verification-troubleshooting.md +0 -122
  71. package/docs/michi-development/testing/pre-publish-checklist.md +0 -560
  72. package/docs/michi-development/testing-strategy.md +0 -87
  73. package/docs/plan.md +0 -275
  74. package/docs/user-guide/getting-started/github-token-setup.md +0 -510
  75. package/docs/user-guide/getting-started/new-repository-setup.md +0 -704
  76. package/docs/user-guide/getting-started/quick-start.md +0 -212
  77. package/docs/user-guide/getting-started/setup.md +0 -819
  78. package/docs/user-guide/guides/agent-skills-integration.md +0 -222
  79. package/docs/user-guide/guides/customization.md +0 -537
  80. package/docs/user-guide/guides/internationalization.md +0 -540
  81. package/docs/user-guide/guides/migration-guide.md +0 -138
  82. package/docs/user-guide/guides/multi-project.md +0 -368
  83. package/docs/user-guide/guides/multi-repo-guide.md +0 -1147
  84. package/docs/user-guide/guides/phase-automation.md +0 -419
  85. package/docs/user-guide/guides/workflow.md +0 -584
  86. package/docs/user-guide/hands-on/README.md +0 -142
  87. package/docs/user-guide/hands-on/claude-agent-setup.md +0 -597
  88. package/docs/user-guide/hands-on/claude-setup.md +0 -452
  89. package/docs/user-guide/hands-on/cursor-setup.md +0 -353
  90. package/docs/user-guide/hands-on/troubleshooting.md +0 -964
  91. package/docs/user-guide/hands-on/verification-checklist.md +0 -439
  92. package/docs/user-guide/hands-on/workflow-walkthrough.md +0 -909
  93. package/docs/user-guide/reference/config.md +0 -589
  94. package/docs/user-guide/reference/multi-repo-api.md +0 -771
  95. package/docs/user-guide/reference/quick-reference.md +0 -297
  96. package/docs/user-guide/reference/security-test-payloads.md +0 -50
  97. package/docs/user-guide/reference/tasks-template.md +0 -550
  98. package/docs/user-guide/release/ci-setup-java.md +0 -114
  99. package/docs/user-guide/release/ci-setup-nodejs.md +0 -94
  100. package/docs/user-guide/release/ci-setup-php.md +0 -102
  101. package/docs/user-guide/release/ci-setup-troubleshooting.md +0 -94
  102. package/docs/user-guide/release/ci-setup.md +0 -188
  103. package/docs/user-guide/release/release-flow.md +0 -476
  104. package/docs/user-guide/templates/test-specs/README.md +0 -173
  105. package/docs/user-guide/templates/test-specs/e2e-test-spec-template.md +0 -553
  106. package/docs/user-guide/templates/test-specs/integration-test-spec-template.md +0 -435
  107. package/docs/user-guide/templates/test-specs/performance-test-spec-template.md +0 -454
  108. package/docs/user-guide/templates/test-specs/security-test-spec-template.md +0 -625
  109. package/docs/user-guide/templates/test-specs/unit-test-spec-template.md +0 -328
  110. package/docs/user-guide/testing/integration-tests.md +0 -312
  111. package/docs/user-guide/testing/tdd-cycle.md +0 -349
  112. package/docs/user-guide/testing/test-execution-flow.md +0 -396
  113. package/docs/user-guide/testing/test-failure-handling.md +0 -521
  114. package/docs/user-guide/testing/test-planning-flow.md +0 -185
  115. package/docs/user-guide/testing-strategy.md +0 -185
  116. package/docs/verification-guide.md +0 -518
@@ -1,1147 +0,0 @@
1
- # Multi-Repo管理ガイド
2
-
3
- > **凡例について**: `<feature>` などの記号の意味は [README.md#凡例の記号説明](../README.md#凡例の記号説明) を参照してください。
4
-
5
- ## 概要
6
-
7
- ### Multi-Repo機能とは
8
-
9
- Multi-Repo機能は、1つのプロジェクトで複数のGitHubリポジトリを統合的に管理するための機能です。マイクロサービスアーキテクチャやモノレポ分割後のプロジェクトなど、複数リポジトリにまたがる開発を効率化します。
10
-
11
- ### 対象ユーザー
12
-
13
- - マイクロサービスアーキテクチャで開発しているチーム
14
- - フロントエンド・バックエンド・インフラを別リポジトリで管理しているチーム
15
- - 複数リポジトリのCI/CD状態を一元管理したいチーム
16
- - 複数リポジトリの統合ドキュメントをConfluenceで管理したいチーム
17
-
18
- ### 主要機能
19
-
20
- 1. **プロジェクト管理**: 複数リポジトリをグループ化してプロジェクトとして管理
21
- 2. **CI結果集約**: 複数リポジトリのGitHub Actions実行結果を一覧表示
22
- 3. **テスト実行**: プロジェクト単位でテストスクリプトを実行
23
- 4. **Confluence同期**: プロジェクトドキュメントをConfluenceに自動同期
24
- 5. **一覧表示**: プロジェクトとリポジトリの情報を一覧表示
25
-
26
- ## セットアップ
27
-
28
- ### 前提条件
29
-
30
- - Node.js 18以上
31
- - GitHub Personal Access Token
32
- - Atlassian (Confluence/JIRA) アカウント(Confluence同期を使用する場合)
33
-
34
- ### 依存関係のインストール
35
-
36
- ```bash
37
- npm install
38
- ```
39
-
40
- ### 環境変数の設定
41
-
42
- #### GitHub Token(必須)
43
-
44
- GitHub Actions APIを使用してCI結果を取得するために必要です。
45
-
46
- ```bash
47
- # .env ファイルに追加
48
- GITHUB_TOKEN=ghp_your_github_personal_access_token
49
- ```
50
-
51
- **Token作成手順**:
52
- 1. GitHub Settings → Developer settings → Personal access tokens → Tokens (classic)
53
- 2. "Generate new token (classic)"をクリック
54
- 3. 必要なスコープを選択:
55
- - `repo` (フル権限、private repositoriesへのアクセスに必要)
56
- - `read:org` (organizationのリポジトリにアクセスする場合)
57
- 4. トークンをコピーして環境変数に設定
58
-
59
- #### Atlassian認証情報(Confluence同期を使用する場合)
60
-
61
- ```bash
62
- # .env ファイルに追加
63
- ATLASSIAN_URL=https://your-domain.atlassian.net
64
- ATLASSIAN_EMAIL=your-email@example.com
65
- ATLASSIAN_API_TOKEN=your_atlassian_api_token
66
- ```
67
-
68
- **API Token作成手順**:
69
- 1. Atlassian Account Settings → Security → API tokens
70
- 2. "Create API token"をクリック
71
- 3. トークン名を入力して作成
72
- 4. トークンをコピーして環境変数に設定
73
-
74
- ### カスタムコマンド(スキル)の配布
75
-
76
- Multi-Repo AI支援コマンドを使用するには、プロジェクトに `.claude/commands/` を配布する必要があります。
77
-
78
- #### 初回セットアップ時
79
-
80
- プロジェクトで初めて Michi を使用する場合、使用する環境に応じて以下のコマンドを実行してください:
81
-
82
- ```bash
83
- # Claude Code 環境の場合
84
- michi init --claude
85
-
86
- # Claude Code Subagents 環境の場合
87
- michi init --claude-agent
88
-
89
- # Cursor 環境の場合
90
- michi init --cursor
91
- ```
92
-
93
- #### 環境オプションの選択
94
-
95
- | オプション | 環境 | ルールディレクトリ | 用途 |
96
- |-----------|------|-------------------|------|
97
- | `--claude` | Claude Code | `.claude/rules/` | 通常の Claude Code 使用 |
98
- | `--claude-agent` | Claude Code Subagents | `.claude/agents/` | Claude Code Subagents 使用 |
99
- | `--cursor` | Cursor IDE | `.cursor/rules/` | Cursor IDE 使用 |
100
-
101
- **注意**: どの環境でも、コマンドディレクトリは `.claude/commands/` に統一されています(v0.8.7以降)。
102
-
103
- #### ディレクトリ構造
104
-
105
- **Claude Code (`--claude`) の場合**:
106
- ```
107
- .claude/
108
- ├── rules/ # Michi のルールファイル
109
- └── commands/ # カスタムコマンド(スキル)
110
- ├── kiro/ # kiro: 単一リポジトリ用コマンド
111
- ├── michi/ # michi: Michi拡張コマンド
112
- └── michi-multi-repo/ # Multi-Repo AI支援コマンド
113
- ├── spec-init.md
114
- ├── spec-requirements.md
115
- └── spec-design.md
116
- ```
117
-
118
- **Claude Code Subagents (`--claude-agent`) の場合**:
119
- ```
120
- .claude/
121
- ├── agents/ # Subagent 用ルールファイル
122
- └── commands/ # カスタムコマンド(スキル)
123
- ├── kiro/
124
- ├── michi/
125
- └── michi-multi-repo/
126
- ```
127
-
128
- **Cursor IDE (`--cursor`) の場合**:
129
- ```
130
- .cursor/
131
- ├── rules/ # Cursor 用ルールファイル
132
- └── commands/ # カスタムコマンド(スキル)
133
- ├── kiro/
134
- ├── michi/
135
- └── michi-multi-repo/
136
- ```
137
-
138
- #### 既存プロジェクトへの追加
139
-
140
- 既に `.claude/` や `.cursor/` ディレクトリが存在するプロジェクトの場合も、`michi init` を再実行することで、不足しているコマンドが追加されます:
141
-
142
- ```bash
143
- # 使用している環境に応じて選択
144
- michi init --claude # Claude Code 環境
145
- michi init --claude-agent # Claude Code Subagents 環境
146
- michi init --cursor # Cursor 環境
147
- ```
148
-
149
- **注意**:
150
- - 既存のファイルは上書きされます。カスタマイズしたファイルがある場合は、事前にバックアップを取ってください
151
- - 環境オプション(`--claude`, `--claude-agent`, `--cursor`)は、初回セットアップ時と同じものを使用してください
152
-
153
- #### コマンドが正しく配布されたか確認
154
-
155
- 以下のコマンドで、`.claude/commands/` の構造を確認できます:
156
-
157
- ```bash
158
- ls -la .claude/commands/
159
- # 以下が表示されること:
160
- # - kiro/
161
- # - michi/
162
- # - michi-multi-repo/
163
- ```
164
-
165
- #### Multi-Repo AIコマンドの利用
166
-
167
- 配布後、Claude Code で以下のコマンドが利用可能になります:
168
-
169
- | コマンド | 説明 |
170
- |---------|------|
171
- | `/michi-multi-repo:spec-init` | プロジェクト初期化(プロジェクト説明から自動生成) |
172
- | `/michi-multi-repo:spec-requirements` | 要件定義書の自動生成 |
173
- | `/michi-multi-repo:spec-design` | 設計書の自動生成 |
174
-
175
- **使用例**:
176
- ```bash
177
- # Chirper プロジェクトを初期化
178
- /michi-multi-repo:spec-init "Twitter風SNSアプリケーション Chirper をオニオンアーキテクチャで構築" --jira PC --confluence-space MICHI
179
- ```
180
-
181
- #### トラブルシューティング
182
-
183
- **Q: コマンドが認識されない**
184
-
185
- A: 以下を確認してください:
186
- 1. `.claude/commands/michi-multi-repo/` ディレクトリが存在するか
187
- 2. `michi init --claude` を実行したか
188
- 3. Claude Code を再起動してみる
189
-
190
- **Q: 古いコマンド名 (`/michi_multi_repo:*`) を使っていた**
191
-
192
- A: v0.8.7 以降では `/michi-multi-repo:*` に変更されました。詳細は [migration-guide.md](migration-guide.md) を参照してください。
193
-
194
- ## 基本的な使い方
195
-
196
- ### 1. プロジェクトの初期化
197
-
198
- 新しいMulti-Repoプロジェクトを作成します。
199
-
200
- ```bash
201
- michi multi-repo:init <project-name> --jira <JIRA-KEY> --confluence-space <SPACE>
202
- ```
203
-
204
- **例**:
205
- ```bash
206
- michi multi-repo:init my-microservices --jira MSV --confluence-space MSV
207
- ```
208
-
209
- **生成されるファイル**:
210
- - `docs/michi/<project-name>/`: プロジェクトドキュメント用ディレクトリ
211
- - `overview/requirements.md`: 要件定義書(テンプレート)
212
- - `overview/architecture.md`: アーキテクチャ設計書(テンプレート)
213
- - `design/sequence.md`: シーケンス図(テンプレート)
214
- - `test/strategy.md`: テスト戦略書(テンプレート)
215
- - `.michi/config.json`: プロジェクト設定(multiRepoProjectsに追加)
216
-
217
- ### 2. リポジトリの登録
218
-
219
- プロジェクトにGitHubリポジトリを追加します。
220
-
221
- ```bash
222
- michi multi-repo:add-repo <project-name> --name <repo-name> --url <github-url> --branch <branch>
223
- ```
224
-
225
- **例**:
226
- ```bash
227
- # フロントエンドリポジトリを追加
228
- michi multi-repo:add-repo my-microservices \
229
- --name frontend \
230
- --url https://github.com/myorg/frontend \
231
- --branch main
232
-
233
- # バックエンドリポジトリを追加
234
- michi multi-repo:add-repo my-microservices \
235
- --name backend \
236
- --url https://github.com/myorg/backend \
237
- --branch main
238
-
239
- # インフラリポジトリを追加
240
- michi multi-repo:add-repo my-microservices \
241
- --name infrastructure \
242
- --url https://github.com/myorg/infra \
243
- --branch main
244
- ```
245
-
246
- ### 3. CI結果の集約
247
-
248
- プロジェクト内の全リポジトリのGitHub Actions実行結果を一覧表示します。
249
-
250
- ```bash
251
- michi multi-repo:ci-status <project-name>
252
- ```
253
-
254
- **出力例**:
255
- ```
256
- === Multi-Repo CI Status ===
257
- Project: my-microservices
258
- Repositories: 3
259
-
260
- Repository: frontend (main)
261
- Latest Workflow Run: Build and Test
262
- Status: ✅ success
263
- Conclusion: success
264
- Created: 2025-12-17T10:30:00Z
265
- URL: https://github.com/myorg/frontend/actions/runs/12345
266
-
267
- Repository: backend (main)
268
- Latest Workflow Run: CI
269
- Status: ✅ success
270
- Conclusion: success
271
- Created: 2025-12-17T10:25:00Z
272
- URL: https://github.com/myorg/backend/actions/runs/12346
273
-
274
- Repository: infrastructure (main)
275
- Latest Workflow Run: Deploy
276
- Status: ❌ failure
277
- Conclusion: failure
278
- Created: 2025-12-17T10:20:00Z
279
- URL: https://github.com/myorg/infra/actions/runs/12347
280
-
281
- CI結果の集約が完了しました
282
- ```
283
-
284
- **キャッシング機能**:
285
- - CI結果は `.ci-cache.json` にキャッシュされます(有効期限: 15分)
286
- - キャッシュがある場合は高速に結果を表示します
287
-
288
- ### 4. テストスクリプトの実行
289
-
290
- プロジェクトに登録されたテストスクリプトを実行します。
291
-
292
- ```bash
293
- # Phase A テスト(PR時)
294
- michi multi-repo:test <project-name> --phase A
295
-
296
- # Phase B テスト(リリース前)
297
- michi multi-repo:test <project-name> --phase B
298
- ```
299
-
300
- **テストスクリプトの登録方法**:
301
-
302
- `.michi/config.json` を編集:
303
- ```json
304
- {
305
- "multiRepoProjects": [
306
- {
307
- "name": "my-microservices",
308
- "jiraKey": "MSV",
309
- "confluenceSpace": "MSV",
310
- "createdAt": "2025-12-17T00:00:00Z",
311
- "repositories": [...],
312
- "testScripts": {
313
- "phaseA": [
314
- "npm test:unit",
315
- "npm run lint",
316
- "npm run type-check"
317
- ],
318
- "phaseB": [
319
- "npm test:integration",
320
- "npm test:e2e",
321
- "npm test:performance"
322
- ]
323
- }
324
- }
325
- ]
326
- }
327
- ```
328
-
329
- ### 5. Confluenceへの同期
330
-
331
- プロジェクトドキュメントをConfluenceに同期します。
332
-
333
- ```bash
334
- # 全ドキュメントを同期
335
- michi multi-repo:confluence-sync <project-name>
336
-
337
- # 特定のドキュメントタイプのみ同期
338
- michi multi-repo:confluence-sync <project-name> --doc-type requirements
339
- michi multi-repo:confluence-sync <project-name> --doc-type architecture
340
- michi multi-repo:confluence-sync <project-name> --doc-type sequence
341
- michi multi-repo:confluence-sync <project-name> --doc-type strategy
342
- ```
343
-
344
- **同期されるドキュメント**:
345
- - `requirements.md` → Confluence Requirements ページ
346
- - `architecture.md` → Confluence Architecture ページ
347
- - `sequence.md` → Confluence Sequence Diagrams ページ
348
- - `strategy.md` → Confluence Test Strategy ページ
349
-
350
- **Mermaidダイアグラムの変換**:
351
- - Markdown内のMermaidダイアグラムは自動的にConfluence形式に変換されます
352
-
353
- ### 6. プロジェクト一覧の表示
354
-
355
- 登録されているプロジェクトとリポジトリの一覧を表示します。
356
-
357
- ```bash
358
- michi multi-repo:list
359
- ```
360
-
361
- **出力例**:
362
- ```
363
- === Multi-Repo Projects ===
364
-
365
- Project: my-microservices
366
- JIRA Key: MSV
367
- Confluence Space: MSV
368
- Created: 2025-12-17T00:00:00Z
369
-
370
- Repositories (3):
371
- 1. frontend
372
- URL: https://github.com/myorg/frontend
373
- Branch: main
374
-
375
- 2. backend
376
- URL: https://github.com/myorg/backend
377
- Branch: main
378
-
379
- 3. infrastructure
380
- URL: https://github.com/myorg/infra
381
- Branch: main
382
-
383
- Test Scripts:
384
- Phase A: npm test:unit, npm run lint, npm run type-check
385
- Phase B: npm test:integration, npm test:e2e, npm test:performance
386
-
387
- Total Projects: 1
388
- ```
389
-
390
- ## コマンドリファレンス
391
-
392
- ### multi-repo:init
393
-
394
- 新しいMulti-Repoプロジェクトを初期化します。
395
-
396
- **構文**:
397
- ```bash
398
- michi multi-repo:init <project-name> --jira <JIRA-KEY> --confluence-space <SPACE>
399
- ```
400
-
401
- **引数**:
402
- - `<project-name>`: プロジェクト名(必須)
403
- - 1-100文字
404
- - パス区切り文字 (`/`, `\`)、相対パス (`.`, `..`)、制御文字は使用不可
405
-
406
- **オプション**:
407
- - `--jira <JIRA-KEY>`: JIRAプロジェクトキー(必須)
408
- - 2-10文字の大文字英字のみ
409
- - 例: `MSV`, `PROJ`, `MICROSVCS`
410
- - `--confluence-space <SPACE>`: Confluenceスペースキー(必須)
411
- - 空でない文字列
412
- - 例: `MSV`, `PROJ`
413
-
414
- **例**:
415
- ```bash
416
- michi multi-repo:init my-microservices --jira MSV --confluence-space MSV
417
- ```
418
-
419
- ### multi-repo:add-repo
420
-
421
- プロジェクトにリポジトリを追加します。
422
-
423
- **構文**:
424
- ```bash
425
- michi multi-repo:add-repo <project-name> --name <repo-name> --url <github-url> --branch <branch>
426
- ```
427
-
428
- **引数**:
429
- - `<project-name>`: プロジェクト名(必須)
430
-
431
- **オプション**:
432
- - `--name <repo-name>`: リポジトリ名(必須)
433
- - 空でない文字列
434
- - `--url <github-url>`: GitHub URL(必須)
435
- - `https://github.com/{owner}/{repo}` 形式
436
- - HTTPSプロトコル必須(HTTP、SSH不可)
437
- - `.git` 拡張子は不要
438
- - `--branch <branch>`: ブランチ名(必須)
439
- - デフォルトブランチ(通常は `main` または `master`)
440
-
441
- **例**:
442
- ```bash
443
- michi multi-repo:add-repo my-microservices \
444
- --name api-gateway \
445
- --url https://github.com/myorg/api-gateway \
446
- --branch main
447
- ```
448
-
449
- ### multi-repo:ci-status
450
-
451
- プロジェクトのCI結果を集約して表示します。
452
-
453
- **構文**:
454
- ```bash
455
- michi multi-repo:ci-status <project-name>
456
- ```
457
-
458
- **引数**:
459
- - `<project-name>`: プロジェクト名(必須)
460
-
461
- **動作**:
462
- 1. 各リポジトリの最新ワークフロー実行結果をGitHub APIから取得
463
- 2. キャッシュファイル (`.ci-cache.json`) に保存(有効期限: 15分)
464
- 3. 結果を一覧表示
465
-
466
- **パフォーマンス**:
467
- - 並列処理により高速化(10リポジトリで30秒以内)
468
- - キャッシュヒット時は即座に表示
469
-
470
- **例**:
471
- ```bash
472
- michi multi-repo:ci-status my-microservices
473
- ```
474
-
475
- ### multi-repo:test
476
-
477
- プロジェクトのテストスクリプトを実行します。
478
-
479
- **構文**:
480
- ```bash
481
- michi multi-repo:test <project-name> --phase <phase>
482
- ```
483
-
484
- **引数**:
485
- - `<project-name>`: プロジェクト名(必須)
486
-
487
- **オプション**:
488
- - `--phase <phase>`: テストフェーズ(必須)
489
- - `A`: Phase A テスト(PR時: unit, lint, build)
490
- - `B`: Phase B テスト(リリース前: integration, e2e, performance, security)
491
-
492
- **例**:
493
- ```bash
494
- # Phase A テスト
495
- michi multi-repo:test my-microservices --phase A
496
-
497
- # Phase B テスト
498
- michi multi-repo:test my-microservices --phase B
499
- ```
500
-
501
- ### multi-repo:confluence-sync
502
-
503
- プロジェクトドキュメントをConfluenceに同期します。
504
-
505
- **構文**:
506
- ```bash
507
- michi multi-repo:confluence-sync <project-name> [--doc-type <type>]
508
- ```
509
-
510
- **引数**:
511
- - `<project-name>`: プロジェクト名(必須)
512
-
513
- **オプション**:
514
- - `--doc-type <type>`: ドキュメントタイプ(オプション)
515
- - `requirements`: 要件定義書のみ
516
- - `architecture`: アーキテクチャ設計書のみ
517
- - `sequence`: シーケンス図のみ
518
- - `strategy`: テスト戦略書のみ
519
- - 未指定: 全ドキュメントを同期
520
-
521
- **動作**:
522
- 1. 親ページ(プロジェクト名)を作成または取得
523
- 2. 各ドキュメントを子ページとして作成または更新
524
- 3. Mermaidダイアグラムを自動変換
525
-
526
- **例**:
527
- ```bash
528
- # 全ドキュメントを同期
529
- michi multi-repo:confluence-sync my-microservices
530
-
531
- # 要件定義書のみ同期
532
- michi multi-repo:confluence-sync my-microservices --doc-type requirements
533
- ```
534
-
535
- ### multi-repo:list
536
-
537
- 登録されているプロジェクトの一覧を表示します。
538
-
539
- **構文**:
540
- ```bash
541
- michi multi-repo:list
542
- ```
543
-
544
- **引数**: なし
545
-
546
- **動作**:
547
- - `.michi/config.json` からプロジェクト情報を読み込み
548
- - プロジェクト名、JIRA キー、Confluence スペース、リポジトリ一覧を表示
549
-
550
- **例**:
551
- ```bash
552
- michi multi-repo:list
553
- ```
554
-
555
- ## 既存ユーザーのためのマイグレーションガイド
556
-
557
- このセクションは、既存のMichiユーザーがMulti-Repo機能を導入する際の手順を説明します。
558
-
559
- ### 概要
560
-
561
- Multi-Repo機能はMichiに新しく追加された機能です。既存のMichi機能に影響を与えず、追加のコマンド群として提供されます。
562
-
563
- **主な特徴**:
564
- - **後方互換性**: 既存のMichiコマンドとワークフローに影響なし
565
- - **オプトイン**: Multi-Repo機能を使用する場合のみ、設定を追加
566
- - **自動マイグレーション**: 初回使用時に自動的に設定ファイルが拡張される
567
-
568
- ### 変更点(v0.5.0 → v1.0.0)
569
-
570
- #### 1. config.jsonスキーマの拡張
571
-
572
- `.michi/config.json` に新しいフィールド `multiRepoProjects` が追加されます。
573
-
574
- **変更前(v0.5.0)**:
575
- ```json
576
- {
577
- "confluence": { ... },
578
- "jira": { ... },
579
- "workflow": { ... },
580
- "validation": { ... },
581
- "atlassian": { ... },
582
- "project": { ... }
583
- }
584
- ```
585
-
586
- **変更後(v1.0.0)**:
587
- ```json
588
- {
589
- "confluence": { ... },
590
- "jira": { ... },
591
- "workflow": { ... },
592
- "validation": { ... },
593
- "atlassian": { ... },
594
- "project": { ... },
595
- "multiRepoProjects": []
596
- }
597
- ```
598
-
599
- 重要: `multiRepoProjects` フィールドが存在しない場合、Michiは自動的に空配列 `[]` として扱います。手動で追加する必要はありません。
600
-
601
- #### 2. 新規コマンドの追加
602
-
603
- 以下の6つのコマンドが追加されます:
604
-
605
- | コマンド | Phase | 説明 |
606
- |---------|-------|------|
607
- | `michi multi-repo:init` | 1 (MVP) | プロジェクト初期化 |
608
- | `michi multi-repo:add-repo` | 1 (MVP) | リポジトリ登録 |
609
- | `michi multi-repo:list` | 1 (MVP) | プロジェクト一覧表示 |
610
- | `michi multi-repo:ci-status` | 2 | CI結果集約 |
611
- | `michi multi-repo:test` | 2 | テスト実行 |
612
- | `michi multi-repo:confluence-sync` | 3 | Confluence同期 |
613
-
614
- #### 3. 環境変数の追加(オプション)
615
-
616
- **Phase 2機能を使用する場合**:
617
- ```bash
618
- export GITHUB_TOKEN="ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
619
- ```
620
-
621
- **Phase 3機能を使用する場合**:
622
- ```bash
623
- export ATLASSIAN_URL="https://your-company.atlassian.net"
624
- export ATLASSIAN_EMAIL="your-email@example.com"
625
- export ATLASSIAN_API_TOKEN="your-api-token"
626
- ```
627
-
628
- 注意: 既存のMichiでConfluence機能を使用している場合、これらの環境変数は既に設定されているため、追加の設定は不要です。
629
-
630
- ### マイグレーション手順
631
-
632
- #### ステップ1: Michiをv1.0.0にアップグレード
633
-
634
- ```bash
635
- npm install -g @sk8metal/michi-cli@latest
636
- ```
637
-
638
- アップグレード後、バージョンを確認します。
639
-
640
- ```bash
641
- michi --version
642
- # @sk8metal/michi-cli v1.0.0
643
- ```
644
-
645
- #### ステップ2: 環境変数の設定(オプション)
646
-
647
- **Phase 2機能を使用する場合**:
648
-
649
- GitHub Personal Access Tokenを取得し、環境変数に設定します。
650
-
651
- GitHub Personal Access Tokenの取得方法:
652
- 1. GitHubにログイン
653
- 2. Settings → Developer settings → Personal access tokens → Tokens (classic)
654
- 3. "Generate new token (classic)" をクリック
655
- 4. 必要なスコープを選択:
656
- - `repo`: プライベートリポジトリへのアクセス(推奨)
657
- - `public_repo`: パブリックリポジトリのみへのアクセス
658
- - `workflow`: GitHub Actionsへのアクセス(必須)
659
- 5. トークンを生成してコピー
660
-
661
- **環境変数の設定**:
662
- ```bash
663
- # ~/.bashrc または ~/.zshrc に追加
664
- export GITHUB_TOKEN="ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
665
-
666
- # 変更を反映
667
- source ~/.bashrc # または source ~/.zshrc
668
- ```
669
-
670
- **Phase 3機能を使用する場合**:
671
-
672
- 既存のMichiでConfluence機能を使用している場合は、既に設定済みのため、この手順はスキップしてください。
673
-
674
- 新規にConfluence機能を使用する場合は、[Confluenceセットアップガイド](../getting-started/setup-guide.md#confluence設定)を参照してください。
675
-
676
- #### ステップ3: Multi-Repoプロジェクトの初期化
677
-
678
- 初めてMulti-Repo機能を使用する際に、自動的に `.michi/config.json` が拡張されます。
679
-
680
- ```bash
681
- # プロジェクト初期化
682
- michi multi-repo:init my-multi-repo-project \
683
- --jira MYPROJ \
684
- --confluence-space MYSPACE
685
- ```
686
-
687
- **実行結果**:
688
- ```
689
- ✅ Multi-Repoプロジェクトの初期化が完了しました
690
-
691
- プロジェクト情報:
692
- 名前: my-multi-repo-project
693
- JIRAキー: MYPROJ
694
- Confluenceスペース: MYSPACE
695
-
696
- 作成されたディレクトリ:
697
- docs/michi/my-multi-repo-project/
698
- ├── overview/
699
- │ ├── requirements.md
700
- │ ├── architecture.md
701
- │ └── multi-repo.md
702
- ├── steering/
703
- ├── tests/
704
- └── docs/
705
-
706
- 設定ファイルを更新しました: .michi/config.json
707
- ```
708
-
709
- #### ステップ4: リポジトリの登録
710
-
711
- Multi-Repoプロジェクトにリポジトリを登録します。
712
-
713
- ```bash
714
- # リポジトリ登録
715
- michi multi-repo:add-repo my-multi-repo-project \
716
- --name backend \
717
- --url https://github.com/your-org/backend \
718
- --branch main
719
-
720
- michi multi-repo:add-repo my-multi-repo-project \
721
- --name frontend \
722
- --url https://github.com/your-org/frontend \
723
- --branch main
724
- ```
725
-
726
- #### ステップ5: 動作確認
727
-
728
- プロジェクト一覧を表示して、正常に登録されたことを確認します。
729
-
730
- ```bash
731
- michi multi-repo:list
732
- ```
733
-
734
- **実行結果**:
735
- ```
736
- ========================================
737
- Multi-Repo プロジェクト一覧
738
- ========================================
739
-
740
- プロジェクト: my-multi-repo-project
741
- JIRAキー: MYPROJ
742
- Confluenceスペース: MYSPACE
743
- 作成日時: 2025-12-17T10:00:00+09:00
744
- リポジトリ数: 2
745
-
746
- リポジトリ:
747
- 1. backend
748
- URL: https://github.com/your-org/backend
749
- ブランチ: main
750
-
751
- 2. frontend
752
- URL: https://github.com/your-org/frontend
753
- ブランチ: main
754
-
755
- ========================================
756
- 合計プロジェクト数: 1
757
- ========================================
758
- ```
759
-
760
- ### 既存機能への影響
761
-
762
- #### 影響なし
763
-
764
- 以下の既存Michi機能は、Multi-Repo機能の追加によって**影響を受けません**。
765
-
766
- **Spec-Driven Developmentワークフロー**:
767
- ```bash
768
- # 既存のワークフローは変更なし
769
- /kiro:spec-init "feature-name"
770
- /kiro:spec-requirements feature-name
771
- /kiro:spec-design feature-name
772
- /kiro:spec-tasks feature-name
773
- /kiro:spec-impl feature-name
774
- ```
775
-
776
- **Confluence/JIRA統合**:
777
- ```bash
778
- # 既存のConfluence/JIRAコマンドは変更なし
779
- michi confluence:sync
780
- michi jira:sync
781
- ```
782
-
783
- **設定管理**:
784
- ```bash
785
- # 既存の設定コマンドは変更なし
786
- michi config:validate
787
- michi migrate
788
- ```
789
-
790
- 既存の設定フィールド(`confluence`, `jira`, `workflow`, `validation`, `atlassian`, `project`)は変更されません。`multiRepoProjects` フィールドが追加されるのみです。
791
-
792
- #### 注意事項
793
-
794
- **ディレクトリ構造**:
795
-
796
- Multi-Repo機能は `docs/michi/{project-name}/` ディレクトリを使用します。既存のMichi機能と同じディレクトリ構造ですが、プロジェクト名が異なる場合は別のディレクトリが作成されます。
797
-
798
- ```
799
- docs/
800
- ├── michi/
801
- │ ├── my-feature/ # 既存のSpec-Driven Development用
802
- │ │ ├── overview/
803
- │ │ ├── steering/
804
- │ │ └── ...
805
- │ └── my-multi-repo-project/ # Multi-Repo用(新規)
806
- │ ├── overview/
807
- │ ├── steering/
808
- │ └── ...
809
- ```
810
-
811
- **Confluence階層構造**:
812
-
813
- Multi-Repo機能でConfluence同期を使用する場合、以下の階層構造が作成されます。
814
-
815
- ```
816
- Confluenceスペース (例: MYSPACE)
817
- └── my-multi-repo-project (親ページ)
818
- ├── my-multi-repo-project - Requirements
819
- ├── my-multi-repo-project - Architecture
820
- ├── my-multi-repo-project - Sequence Diagrams
821
- └── my-multi-repo-project - Test Strategy
822
- ```
823
-
824
- 既存のConfluenceページとは別の階層構造となるため、影響はありません。
825
-
826
- ## トラブルシューティング
827
-
828
- ### 問題1: GITHUB_TOKEN が設定されていないエラー
829
-
830
- **エラーメッセージ**:
831
- ```
832
- Error: GITHUB_TOKEN environment variable is not set
833
- ```
834
-
835
- **原因**:
836
- `GITHUB_TOKEN` 環境変数が設定されていません。
837
-
838
- **対処法**:
839
- 1. GitHub Personal Access Token を作成(上記「セットアップ」参照)
840
- 2. `.env` ファイルに追加:
841
- ```
842
- GITHUB_TOKEN=ghp_your_token
843
- ```
844
- 3. コマンドを再実行
845
-
846
- ### 問題2: Confluence認証エラー
847
-
848
- **エラーメッセージ**:
849
- ```
850
- Error: Missing Confluence credentials in .env file
851
- ```
852
-
853
- **原因**:
854
- - Atlassian認証情報が正しく設定されていない
855
- - API Tokenの有効期限が切れている
856
- - URLが間違っている
857
-
858
- **対処法**:
859
- 1. `.env` ファイルの設定を確認:
860
- ```
861
- ATLASSIAN_URL=https://your-domain.atlassian.net
862
- ATLASSIAN_EMAIL=your-email@example.com
863
- ATLASSIAN_API_TOKEN=your_token
864
- ```
865
- 2. URLが正しい形式か確認(`https://` で始まり、`.atlassian.net` で終わる)
866
- 3. API Tokenを再作成して設定
867
-
868
- ### 問題3: プロジェクト名にパス区切り文字が含まれているエラー
869
-
870
- **エラーメッセージ**:
871
- ```
872
- Error: Project name must not contain path traversal characters (/, \), relative path components (., ..), or control characters
873
- ```
874
-
875
- **原因**:
876
- セキュリティ対策として、プロジェクト名にパス区切り文字(`/`, `\`)、相対パス(`.`, `..`)、制御文字が禁止されています。
877
-
878
- **解決方法**:
879
-
880
- プロジェクト名を変更して、以下の文字を含まないようにしてください。
881
-
882
- - パス区切り文字: `/`, `\`
883
- - 相対パス: `.`, `..`
884
- - 制御文字: `\x00`-`\x1F`, `\x7F`
885
-
886
- **例**:
887
- ```bash
888
- # 不正な例
889
- michi multi-repo:init my/project # スラッシュを含む
890
- michi multi-repo:init ../project # 相対パスを含む
891
-
892
- # 正しい例
893
- michi multi-repo:init my-project
894
- michi multi-repo:init my_project
895
- michi multi-repo:init myproject
896
- ```
897
-
898
- ### 問題4: リポジトリURLが無効
899
-
900
- **エラーメッセージ**:
901
- ```
902
- Error: Repository URL must be in GitHub format: https://github.com/{owner}/{repo}
903
- ```
904
-
905
- **原因**:
906
- セキュリティ対策として、GitHub HTTPS URLのみが許可されています。
907
-
908
- **解決方法**:
909
-
910
- リポジトリURLを以下の形式に変更してください。
911
-
912
- ```
913
- https://github.com/{owner}/{repo}
914
- ```
915
-
916
- **例**:
917
- ```bash
918
- # 不正な例
919
- --url git@github.com:your-org/repo.git # SSH URL
920
- --url https://github.com/your-org/repo.git # .git拡張子を含む
921
- --url http://github.com/your-org/repo # HTTP (非セキュア)
922
-
923
- # 正しい例
924
- --url https://github.com/your-org/repo
925
- ```
926
-
927
- ### 問題5: GitHub API レート制限エラー
928
-
929
- **エラーメッセージ**:
930
- ```
931
- Warning: GitHub API rate limit exceeded. Retrying after X seconds...
932
- ```
933
-
934
- **原因**:
935
- GitHub API呼び出しがレート制限(5,000リクエスト/時間)に達した。
936
-
937
- **解決方法**:
938
-
939
- Michiは自動的にExponential Backoffで再試行します。以下の対策を検討してください。
940
-
941
- 1. **待機**: 自動再試行が完了するまで待つ(最大3回再試行)
942
- 2. **キャッシング活用**: CI結果は15分間キャッシュされるため、頻繁な実行を避ける
943
- 3. **GitHub Enterprise**: より高いレート制限が必要な場合は、GitHub Enterpriseの使用を検討
944
-
945
- ### 問題6: config.jsonが破損している
946
-
947
- **エラーメッセージ**:
948
- ```
949
- Error: Failed to parse config: Unexpected token } in JSON at position X
950
- ```
951
-
952
- **原因**:
953
- `.michi/config.json` が不正なJSON形式になっている。
954
-
955
- **解決方法**:
956
-
957
- 1. バックアップが存在する場合、復元する
958
-
959
- ```bash
960
- cp .michi/config.json.backup .michi/config.json
961
- ```
962
-
963
- 2. バックアップが存在しない場合、config.jsonを手動で修正する
964
-
965
- ```bash
966
- # JSONリンターで構文エラーを確認
967
- cat .michi/config.json | jq .
968
- ```
969
-
970
- 3. それでも解決しない場合、config.jsonを再生成する
971
-
972
- ```bash
973
- # 既存のconfig.jsonをバックアップ
974
- mv .michi/config.json .michi/config.json.broken
975
-
976
- # 新しいconfig.jsonを生成(Multi-Repoプロジェクトは失われる)
977
- michi config:validate
978
- ```
979
-
980
- ## FAQ
981
-
982
- ### Q1: Multi-Repo機能はどのようなプロジェクトに適していますか?
983
-
984
- **A**: 以下のようなプロジェクトに適しています:
985
- - マイクロサービスアーキテクチャ(複数の独立したサービスリポジトリ)
986
- - フロントエンド・バックエンド分離アーキテクチャ
987
- - モバイルアプリ + API + Webダッシュボード
988
- - インフラ as Code を別リポジトリで管理
989
-
990
- ### Q2: リポジトリの最大数に制限はありますか?
991
-
992
- **A**: 技術的な制限はありませんが、以下の推奨事項があります:
993
- - 実用的には10-20リポジトリ程度を推奨
994
- - CI結果集約は並列処理により高速化(10リポジトリで30秒以内)
995
- - 100リポジトリまでテスト済み(5分以内)
996
-
997
- ### Q3: Private リポジトリは使用できますか?
998
-
999
- **A**: はい、使用できます。GitHub Personal Access Token に `repo` スコープ(フル権限)を付与してください。
1000
-
1001
- ### Q4: GitHub Actions以外のCIツール(Jenkins、CircleCIなど)には対応していますか?
1002
-
1003
- **A**: 現在はGitHub Actionsのみ対応しています。他のCIツールのサポートは将来のバージョンで検討中です。
1004
-
1005
- ### Q5: Mermaidダイアグラムの変換に対応していない記法はありますか?
1006
-
1007
- **A**: 基本的な記法(graph, flowchart, sequenceDiagram, classDiagram)はサポートしています。複雑なカスタマイズや最新の実験的機能は未サポートの可能性があります。
1008
-
1009
- ### Q6: Confluenceの複数スペースに同期できますか?
1010
-
1011
- **A**: 1プロジェクトにつき1つのConfluenceスペースに同期します。複数スペースに同期する場合は、プロジェクトを分けて管理してください。
1012
-
1013
- ### Q7: キャッシュファイル (`.ci-cache.json`) は削除しても大丈夫ですか?
1014
-
1015
- **A**: はい、削除しても問題ありません。次回のCI結果集約時に自動的に再生成されます。ただし、キャッシュがない状態では初回取得に時間がかかります。
1016
-
1017
- ### Q8: テストスクリプトはどこで実行されますか?
1018
-
1019
- **A**: プロジェクトルートディレクトリ(`.michi/config.json` が存在するディレクトリ)で実行されます。リポジトリごとに異なるディレクトリでスクリプトを実行することはできません。
1020
-
1021
- ### Q9: 既存のプロジェクトにMulti-Repo機能を追加できますか?
1022
-
1023
- **A**: はい、可能です。`michi multi-repo:init` を実行すれば、既存の `.michi/config.json` に `multiRepoProjects` セクションが追加されます。
1024
-
1025
- ### Q10: プロジェクトを削除するにはどうすればいいですか?
1026
-
1027
- **A**: 現在、削除用のコマンドはありません。`.michi/config.json` を直接編集して該当プロジェクトを削除してください。将来のバージョンで削除コマンドを追加予定です。
1028
-
1029
- ## AI支援要件定義・設計
1030
-
1031
- Multi-Repoプロジェクトでは、AI支援による要件定義・設計書の自動生成が可能です。
1032
-
1033
- ### 前提条件
1034
-
1035
- - プロジェクトが初期化されていること(`/michi-multi-repo:spec-init` または `michi multi-repo:init`)
1036
- - 1つ以上のリポジトリが登録されていること(`michi multi-repo:add-repo`)
1037
-
1038
- ### 6. AIプロジェクト初期化(NEW)
1039
-
1040
- Multi-Repoプロジェクトを AI支援で初期化します。`michi multi-repo:init` の代替コマンドです。
1041
-
1042
- ```bash
1043
- /michi-multi-repo:spec-init "<プロジェクト説明>" --jira <JIRA_KEY> --confluence-space <SPACE>
1044
- ```
1045
-
1046
- **例**:
1047
- ```bash
1048
- /michi-multi-repo:spec-init "マイクロサービスアーキテクチャでECサイトを構築" --jira MSV --confluence-space MSV
1049
- ```
1050
-
1051
- **機能**:
1052
- - プロジェクト説明からプロジェクト名を自動生成
1053
- - ディレクトリ構造を作成(`docs/michi/{project}/`)
1054
- - メタデータファイル(`spec.json`)を作成
1055
- - `.michi/config.json` の `multiRepoProjects` に登録
1056
- - 初期テンプレートファイルを生成
1057
-
1058
- **出力**:
1059
- - `docs/michi/{project}/spec.json` - メタデータ(phase: initialized)
1060
- - `docs/michi/{project}/overview/requirements.md` - 要件定義書(初期化済み)
1061
- - `docs/michi/{project}/overview/architecture.md` - 設計書(テンプレート)
1062
- - `.michi/config.json` - multiRepoProjects に追加
1063
-
1064
- **`michi multi-repo:init` との違い**:
1065
- - プロジェクト説明を入力して自動的にプロジェクト名を生成
1066
- - spec.json でメタデータ管理(phase、承認状態等)
1067
- - AIコマンドで一貫したワークフローを実現
1068
-
1069
- ### 7. AI要件定義書の生成
1070
-
1071
- プロジェクトの要件定義書をAI支援で自動生成します。
1072
-
1073
- ```bash
1074
- /michi-multi-repo:spec-requirements <project-name>
1075
- ```
1076
-
1077
- **例**:
1078
- ```bash
1079
- /michi-multi-repo:spec-requirements my-microservices
1080
- ```
1081
-
1082
- **生成される内容**:
1083
- - プロジェクト概要
1084
- - サービス構成(登録リポジトリ一覧、依存関係図)
1085
- - インターフェース要件(API契約、イベント契約)
1086
- - 機能要件(EARS形式)
1087
- - 非機能要件(パフォーマンス、セキュリティ等)
1088
-
1089
- **出力先**: `docs/michi/{project}/overview/requirements.md`
1090
-
1091
- ### 8. AI設計書の生成
1092
-
1093
- プロジェクトの技術設計書をAI支援で自動生成します。
1094
-
1095
- ```bash
1096
- /michi-multi-repo:spec-design <project-name> [-y]
1097
- ```
1098
-
1099
- **例**:
1100
- ```bash
1101
- /michi-multi-repo:spec-design my-microservices
1102
- ```
1103
-
1104
- **生成される内容**:
1105
- - システム全体図(C4モデル)
1106
- - サービス横断アーキテクチャ
1107
- - サービス間通信設計
1108
- - 共有コンポーネント
1109
- - デプロイメントアーキテクチャ
1110
- - データフロー図
1111
-
1112
- **出力先**: `docs/michi/{project}/overview/architecture.md`
1113
-
1114
- **オプション**:
1115
- - `-y`: 既存ファイルの上書きを自動承認
1116
-
1117
- ### ワークフロー例(AIコマンド使用)
1118
-
1119
- ```bash
1120
- # 1. AI初期化(NEW - michi multi-repo:init の代替)
1121
- /michi-multi-repo:spec-init "マイクロサービスアーキテクチャでECサイトを構築" --jira MSV --confluence-space MSV
1122
-
1123
- # 2. リポジトリ登録
1124
- michi multi-repo:add-repo my-microservices --name frontend --url https://github.com/myorg/frontend --branch main
1125
- michi multi-repo:add-repo my-microservices --name backend --url https://github.com/myorg/backend --branch main
1126
- michi multi-repo:add-repo my-microservices --name database --url https://github.com/myorg/db-schema --branch main
1127
-
1128
- # 3. AI要件定義書生成(NEW)
1129
- /michi-multi-repo:spec-requirements my-microservices
1130
-
1131
- # 4. AI設計書生成(NEW)
1132
- /michi-multi-repo:spec-design my-microservices
1133
-
1134
- # 5. Confluence同期
1135
- michi multi-repo:confluence-sync my-microservices --doc-type requirements
1136
- michi multi-repo:confluence-sync my-microservices --doc-type architecture
1137
-
1138
- # 6. CI結果確認
1139
- michi multi-repo:ci-status my-microservices
1140
- ```
1141
-
1142
- ## 関連ドキュメント
1143
-
1144
- - [ワークフローガイド](./workflow.md): Michiの全体的な開発ワークフロー
1145
- - [Phase自動化ガイド](./phase-automation.md): テストフェーズの自動化について
1146
- - [カスタマイズガイド](./customization.md): Michiのカスタマイズ方法
1147
- - [Multi-Repo API仕様書](../reference/multi-repo-api.md): Multi-Repo機能のAPI仕様(作成予定)