specdojo 0.2.1 → 0.3.1
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.
- package/.github/agents/specdojo-orchestrator.md +165 -0
- package/CHANGELOG.md +298 -0
- package/README.md +92 -42
- package/dist/agent-response.js +20 -0
- package/dist/agent.js +4 -4
- package/dist/build-command.js +28 -8
- package/dist/catalog-build-references.js +144 -0
- package/dist/catalog-build-render.js +144 -0
- package/dist/catalog-build.js +13 -290
- package/dist/catalog-generate.js +6 -9
- package/dist/catalog-plan-generate.js +2 -2
- package/dist/catalog-plan.js +6 -6
- package/dist/catalog-scaffold.js +4 -4
- package/dist/catalog.js +2 -2
- package/dist/dashboard-exec-records.js +105 -0
- package/dist/dashboard-routines.js +255 -0
- package/dist/dashboard-shared.js +14 -0
- package/dist/dashboard-timeline.js +175 -0
- package/dist/dashboard.js +31 -444
- package/dist/deliverable-trash.js +3 -3
- package/dist/devcontainer-command.js +43 -0
- package/dist/devcontainer-scaffold.js +165 -0
- package/dist/doc-index.js +3 -3
- package/dist/exec-agent-config.js +107 -9
- package/dist/exec-agent-git-state.js +18 -0
- package/dist/exec-agent-protected-config.js +46 -8
- package/dist/exec-commands.js +557 -0
- package/dist/exec-core.js +457 -0
- package/dist/exec-evidence.js +254 -11
- package/dist/exec-handoff.js +336 -0
- package/dist/exec-parent-validation.js +317 -43
- package/dist/exec-pipeline-state.js +74 -9
- package/dist/exec-plans-core.js +693 -0
- package/dist/exec-plans-generation.js +206 -0
- package/dist/exec-plans-storage.js +131 -0
- package/dist/exec-plans.js +3 -1016
- package/dist/exec-protection-handoff.js +43 -2
- package/dist/exec-provider-scaffold.js +247 -15
- package/dist/exec-register-resume.js +65 -19
- package/dist/exec-register.js +9 -3
- package/dist/exec-repo-integration-git.js +23 -0
- package/dist/exec-repo-integration-sync.js +264 -0
- package/dist/exec-repo-integration.js +534 -0
- package/dist/exec-repo-trace.js +182 -0
- package/dist/exec-reporter-output.js +206 -0
- package/dist/exec-reporter.js +525 -248
- package/dist/exec-results.js +103 -71
- package/dist/exec-run-agent-pipeline.js +256 -0
- package/dist/exec-run-agent.js +531 -0
- package/dist/exec-run-in-place.js +541 -0
- package/dist/exec-run-job.js +717 -0
- package/dist/exec-run-lifecycle-commands.js +522 -0
- package/dist/exec-run-lock.js +110 -107
- package/dist/exec-run-mode-shared.js +140 -0
- package/dist/exec-run-register-command.js +244 -0
- package/dist/exec-run-register-core.js +386 -0
- package/dist/exec-run-register-mode.js +206 -0
- package/dist/exec-run-register-resume.js +393 -0
- package/dist/exec-run-register-state.js +322 -0
- package/dist/exec-run-register-worktree.js +509 -0
- package/dist/exec-run-schedule-mode.js +294 -0
- package/dist/exec-run-schedule-prepare.js +353 -0
- package/dist/exec-run-schedule-task.js +572 -0
- package/dist/exec-run-shared.js +399 -0
- package/dist/exec-run.js +11 -4953
- package/dist/exec-shared.js +9 -2
- package/dist/exec-slot-lock.js +242 -0
- package/dist/exec-task-repos.js +415 -0
- package/dist/exec-trial-commands.js +558 -0
- package/dist/exec-trial-core.js +371 -0
- package/dist/exec-trial.js +2 -895
- package/dist/exec-worktree-command.js +87 -43
- package/dist/exec-worktree-ops-commit.js +707 -0
- package/dist/exec-worktree-ops-lifecycle.js +292 -0
- package/dist/exec-worktree-ops-merge.js +303 -0
- package/dist/exec-worktree-ops.js +3 -847
- package/dist/exec-worktree.js +146 -31
- package/dist/exec.js +2 -999
- package/dist/frontmatter-namespace.js +2 -2
- package/dist/grade-apply.js +734 -0
- package/dist/grade-command-apply.js +250 -0
- package/dist/grade-command-inspect.js +138 -0
- package/dist/grade-command-plan.js +101 -0
- package/dist/grade-command-shared.js +68 -0
- package/dist/grade-core.js +307 -0
- package/dist/grade-markdown.js +274 -0
- package/dist/grade-pipeline-state.js +184 -0
- package/dist/grade-plan.js +507 -0
- package/dist/grade-result.js +133 -5
- package/dist/grade-target-discovery.js +265 -0
- package/dist/grade-targets.js +432 -0
- package/dist/grade.js +14 -2451
- package/dist/init-command.js +443 -0
- package/dist/job-definition.js +670 -0
- package/dist/job.js +64 -578
- package/dist/kata-command.js +2 -2
- package/dist/orchestrator.js +213 -0
- package/dist/register-command-types.js +1 -0
- package/dist/register-core.js +363 -0
- package/dist/register-create-commands.js +245 -0
- package/dist/register-event-merge.js +169 -0
- package/dist/register-events.js +4 -4
- package/dist/register-item.js +13 -7
- package/dist/register-maintenance-commands.js +187 -0
- package/dist/register-migration.js +268 -0
- package/dist/register-renumber.js +314 -0
- package/dist/register-transition-commands.js +248 -0
- package/dist/register-update.js +230 -0
- package/dist/register-views.js +256 -0
- package/dist/register.js +175 -1975
- package/dist/review-grade.js +252 -0
- package/dist/review-plan.js +114 -4
- package/dist/review-types.js +40 -1
- package/dist/routine-definition.js +401 -0
- package/dist/routine.js +73 -402
- package/dist/schedule-approach.js +2 -2
- package/dist/schedule-build.js +2 -2
- package/dist/schedule-strategy-generate-document.js +273 -0
- package/dist/schedule-strategy-generate-scope.js +199 -0
- package/dist/schedule-strategy-generate.js +9 -473
- package/dist/schedule.js +19 -6
- package/dist/specdojo-config.js +465 -20
- package/dist/specdojo-gitignore.js +135 -0
- package/dist/specdojo.js +6 -0
- package/dist/viewpoint-document-kinds-check.js +128 -0
- package/dist/yaml-pages.js +4 -4
- package/dist/yaml.js +28 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +348 -90
- package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +51 -17
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +7 -5
- package/docs/ja/specdojo/exec-templates/xrp-freeform-template.md +29 -31
- package/docs/ja/specdojo/exec-templates/xrp-fully-guided-template.md +34 -55
- package/docs/ja/specdojo/exec-templates/xrp-job-template.md +54 -0
- package/docs/ja/specdojo/exec-templates/xrp-recipe-guided-template.md +28 -37
- package/docs/ja/specdojo/exec-templates/xrp-recipe-maintenance-template.md +29 -34
- package/docs/ja/specdojo/exec-templates/xrp-retrofit-template.md +30 -30
- package/docs/ja/specdojo/exec-templates/xrp-rulebook-maintenance-template.md +29 -34
- package/docs/ja/specdojo/exec-templates/xrp-sample-maintenance-template.md +29 -34
- package/docs/ja/specdojo/exec-templates/xrp-template-maintenance-template.md +29 -34
- package/docs/ja/specdojo/exec-templates/xrp-template.md +29 -28
- package/docs/ja/specdojo/exec-templates/xrr-template.md +11 -9
- package/docs/ja/specdojo/guides/docs-editing-guide.md +20 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +103 -70
- package/docs/ja/specdojo/guides/exec-config-guide.md +93 -49
- package/docs/ja/specdojo/guides/exec-operation-guide.md +124 -27
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +40 -11
- package/docs/ja/specdojo/guides/kata-guide.md +4 -4
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +45 -22
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +1 -1
- package/docs/ja/specdojo/guides/practice-system-composition-guide.md +13 -13
- package/docs/ja/specdojo/guides/quick-start-guide.md +260 -30
- package/docs/ja/specdojo/guides/register-operation-guide.md +31 -14
- package/docs/ja/specdojo/guides/release-v0-3-0-migration-guide.md +264 -0
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +22 -1
- package/docs/ja/specdojo/guides/review-guide.md +195 -158
- package/docs/ja/specdojo/guides/routine-operation-guide.md +75 -10
- package/docs/ja/specdojo/guides/ryu-guide.md +32 -30
- package/docs/ja/specdojo/guides/schedule-design-guide.md +10 -10
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +1 -1
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +58 -33
- package/docs/ja/specdojo/guides/use-case-guide.md +3 -3
- package/docs/ja/specdojo/guides/waza-guide.md +15 -2
- package/docs/ja/specdojo/index.md +2 -2
- package/docs/ja/specdojo/philosophy/specdojo-philosophy.md +5 -5
- package/docs/ja/specdojo/recipes/bps-recipe.md +213 -0
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +52 -117
- package/docs/ja/specdojo/references/command-reference.md +335 -92
- package/docs/ja/specdojo/references/deliverables-reference.md +1 -1
- package/docs/ja/specdojo/references/directory-layout-reference.md +13 -9
- package/docs/ja/specdojo/references/specdojo-config-reference.md +107 -24
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +132 -220
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +6 -44
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +2 -0
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +0 -87
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +61 -39
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +0 -87
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +1 -33
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +0 -137
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +0 -247
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +0 -83
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +4 -2
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +78 -150
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +5 -4
- package/docs/ja/specdojo/rulebooks/sch-rulebook.md +1 -1
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +0 -11
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +0 -61
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +2 -47
- package/docs/ja/specdojo/samples/bps-sample.md +74 -21
- package/docs/ja/specdojo/samples/gl-sample.yaml +17 -1
- package/docs/ja/specdojo/samples/ifx-index-sample.yaml +28 -0
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +2 -67
- package/docs/ja/specdojo/samples/pm-organization-sample.md +8 -7
- package/docs/ja/specdojo/samples/pm-raci-sample.md +1 -1
- package/docs/ja/specdojo/samples/tml-sample.yaml +40 -0
- package/docs/ja/specdojo/standards/document-metadata-standard.md +21 -16
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +14 -14
- package/docs/ja/specdojo/standards/job-definition-standard.md +37 -17
- package/docs/ja/specdojo/standards/people-and-organization-definition-standard.md +37 -32
- package/docs/ja/specdojo/standards/philosophy-authoring-standard.md +1 -1
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +21 -11
- package/docs/ja/specdojo/templates/agent-members-template.yaml +25 -0
- package/docs/ja/specdojo/templates/bps-template.md +91 -0
- package/docs/ja/specdojo/templates/pm-members-template.yaml +2 -59
- package/docs/specdojo/schemas/v1/agent-members.schema.yaml +76 -0
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +4 -2
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +55 -2
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +93 -6
- package/docs/specdojo/schemas/v1/exec-reporter-output.schema.yaml +27 -78
- package/docs/specdojo/schemas/v1/gl.schema.yaml +87 -0
- package/docs/specdojo/schemas/v1/grade-result.schema.yaml +33 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +27 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +25 -0
- package/docs/specdojo/schemas/v1/pipeline-state.schema.yaml +49 -1
- package/docs/specdojo/schemas/v1/pm-members.schema.yaml +9 -169
- package/docs/specdojo/schemas/v1/pm-review-viewpoints.schema.yaml +100 -10
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +13 -0
- package/docs/specdojo/schemas/v1/routine-run.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/routine.schema.yaml +7 -0
- package/docs/specdojo/schemas/v1/specdojo-config.schema.yaml +110 -0
- package/package.json +17 -12
- package/templates/antigravity/README.md +29 -4
- package/templates/antigravity/{pm-members-snippet.yaml → agent-members-snippet.yaml} +8 -2
- package/templates/antigravity/exec-defaults-snippet.yaml +10 -7
- package/templates/antigravity/orchestrator.md +18 -7
- package/templates/antigravity/settings.global.json +55 -0
- package/templates/claude/agents/claude-executor.md +14 -0
- package/templates/claude/agents/claude-reporter.md +16 -0
- package/templates/claude/agents/specdojo-orchestrator.md +18 -7
- package/templates/claude/settings.edit.json +27 -1
- package/templates/codex/README.md +5 -4
- package/templates/codex/agents/specdojo-orchestrator.toml +18 -7
- package/templates/codex/orchestrator.md +18 -7
- package/templates/copilot/README.md +7 -5
- package/templates/copilot/{pm-members-snippet.yaml → agent-members-snippet.yaml} +4 -2
- package/templates/devcontainer/devcontainer.json +27 -0
- package/templates/devcontainer/emacs/init.el +88 -0
- package/templates/devcontainer/post-create.sh +62 -0
- package/templates/init-agent-members.yaml +200 -0
- package/templates/init-exec-defaults.yaml +74 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +18 -7
- package/docs/ja/specdojo/exec-templates/xrp-viewpoint-detail-template.md +0 -7
- package/docs/ja/specdojo/exec-templates/xrr-viewpoint-detail-template.md +0 -7
|
@@ -115,7 +115,7 @@ SpecDojo で扱う成果物の種類、目的、推奨ファイル名、主な
|
|
|
115
115
|
| --- | --- | --- | --- | --- | --- |
|
|
116
116
|
| [組織とロールの定義](../rulebooks/pm-organization-rulebook.md) | Organization and Role Definition | `pm-organization` | プロジェクトの体制・関係者構造・意思決定構造を明確にする | プロジェクト全体の体制図、チーム構成、ロール構成 | [レシピ](../recipes/pm-organization-recipe.md) |
|
|
117
117
|
| [ロール定義](../rulebooks/pm-roles-rulebook.md) | Role Definition | `pm-roles.yaml` | プロジェクトで利用するロールを機械処理しやすい形で定義する | ロールコード、ロール名、責務、権限 | [レシピ](../recipes/pm-roles-recipe.md) |
|
|
118
|
-
| [メンバー定義](../rulebooks/pm-members-rulebook.md) | Member Definition | `pm-members.yaml` |
|
|
118
|
+
| [メンバー定義](../rulebooks/pm-members-rulebook.md) | Member Definition | `pm-members.yaml` | 人間メンバーとロールの対応を管理する | 人間メンバー、所属、担当ロール、連絡先、稼働条件 | [レシピ](../recipes/pm-members-recipe.md) |
|
|
119
119
|
| [RACI](../rulebooks/pm-raci-rulebook.md) | RACI | `pm-raci` | 作業や成果物に対する責任分担マトリクスを定義する | 成果物ごとの RACI マトリクス | [レシピ](../recipes/pm-raci-recipe.md) |
|
|
120
120
|
|
|
121
121
|
#### 1.7.3. 管理台帳・管理ビュー
|
|
@@ -17,7 +17,7 @@ SpecDojo Unit のプロジェクトドキュメントとプロダクトドキュ
|
|
|
17
17
|
|
|
18
18
|
- `docs/ja/projects/<project-id>/` 配下のプロジェクトドキュメント構成
|
|
19
19
|
- `docs/ja/product/` 配下のプロダクトドキュメント構成
|
|
20
|
-
- 両者が共有する `docs/ja/specdojo/`
|
|
20
|
+
- 両者が共有する `docs/ja/specdojo/` 配下の型(Kata)のディレクトリ
|
|
21
21
|
|
|
22
22
|
**ここで引けるもの**
|
|
23
23
|
|
|
@@ -32,23 +32,25 @@ SpecDojo Unit のプロジェクトドキュメントとプロダクトドキュ
|
|
|
32
32
|
|
|
33
33
|
## 1. 既定のリポジトリ構成
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
利用プロジェクトでは別リポジトリ構成を既定とし、プロダクトの内容と同じ revision が必要な文書と、SpecDojo の運用記録を別リポジトリに置きます。`app1-specdojo/` は、登録簿・計画・実行記録などのプロジェクトドキュメントを置く **プロジェクトリポジトリ**です。1つのプロジェクトリポジトリに、複数のプロジェクトを格納できます。
|
|
36
36
|
|
|
37
37
|
```text
|
|
38
|
-
workspace/
|
|
38
|
+
app1-workspace/
|
|
39
39
|
├── app1/ # プロダクトリポジトリ
|
|
40
40
|
│ ├── src/
|
|
41
41
|
│ └── docs/ja/product/ # プロダクトドキュメント
|
|
42
|
-
├── app1-specdojo/ #
|
|
42
|
+
├── app1-specdojo/ # プロジェクトリポジトリ
|
|
43
43
|
│ ├── .specdojo/
|
|
44
|
-
│ │
|
|
44
|
+
│ │ ├── specdojo.config.json
|
|
45
|
+
│ │ ├── agent-members.yaml # repository 共通の保護された agent 定義
|
|
46
|
+
│ │ └── exec-defaults.yaml # provider 起動・実行ポリシー
|
|
45
47
|
│ └── docs/ja/
|
|
46
|
-
│ ├── specdojo/ #
|
|
48
|
+
│ ├── specdojo/ # 型(Kata)
|
|
47
49
|
│ └── projects/<project-id>/ # プロジェクト文書と実行記録
|
|
48
|
-
└── app1-worktrees/
|
|
50
|
+
└── app1-specdojo-worktrees/ # task 単位の worktree 置き場(config init がリポジトリ名から設定)
|
|
49
51
|
```
|
|
50
52
|
|
|
51
|
-
|
|
53
|
+
以下のツリーは各リポジトリ内の配置を個別に示します。成果物と実装が常に同じ変更として動く同一リポジトリ構成を選ぶ場合は、両方のツリーを1つのリポジトリの `docs/ja/` 配下へ置けます。
|
|
52
54
|
|
|
53
55
|
## 2. プロジェクトドキュメントの構成
|
|
54
56
|
|
|
@@ -97,7 +99,7 @@ docs/
|
|
|
97
99
|
│ │ │ │ ├── pm-review-viewpoints.yaml # レビュー観点
|
|
98
100
|
│ │ │ │ ├── pm-organization.md # 組織とロールの定義
|
|
99
101
|
│ │ │ │ ├── pm-roles.yaml # ロール定義
|
|
100
|
-
│ │ │ │ ├── pm-members.yaml #
|
|
102
|
+
│ │ │ │ ├── pm-members.yaml # 人間のメンバー定義
|
|
101
103
|
│ │ │ │ └── pm-raci.md # 組織体制とRACI
|
|
102
104
|
│ │ │ │
|
|
103
105
|
│ │ │ ├── 040-current-state/ # 現状(必要な成果物だけを配置)
|
|
@@ -163,7 +165,9 @@ docs/
|
|
|
163
165
|
│ │ │ │ │ ├── runs/ # 入力・task・attempt・結果
|
|
164
166
|
│ │ │ │ │ └── generated/ # checkpoint派生ビュー
|
|
165
167
|
│ │ │ │ ├── grade/ # 継続品質評価(最新状態)
|
|
168
|
+
│ │ │ │ │ ├── results/ # 文書別のgrade resultサイドカー
|
|
166
169
|
│ │ │ │ │ ├── criteria/ # 成果物別のdone_criteria判定詳細
|
|
170
|
+
│ │ │ │ │ ├── pipeline/ # 文書別pipelineの再開state
|
|
167
171
|
│ │ │ │ │ └── generated/ # 再生成可能な派生物(git管理外)
|
|
168
172
|
│ │ │ │ │ └── plans/ # 1文書単位の評価plan
|
|
169
173
|
│ │ │ │ │ ├── kata/ # Kata評価plan
|
|
@@ -13,7 +13,7 @@ SpecDojo Configuration Reference
|
|
|
13
13
|
|
|
14
14
|
**対象範囲**
|
|
15
15
|
|
|
16
|
-
- `.specdojo/specdojo.config.json` のトップレベル、project、`run` の設定キー
|
|
16
|
+
- `.specdojo/specdojo.config.json` のトップレベル、project、`run`、`repos` の設定キー
|
|
17
17
|
|
|
18
18
|
**ここで引けるもの**
|
|
19
19
|
|
|
@@ -39,7 +39,7 @@ SpecDojo Configuration Reference
|
|
|
39
39
|
"project_register_path": "controls/project-register",
|
|
40
40
|
"project_context": ["prj-overview"],
|
|
41
41
|
"run": {
|
|
42
|
-
"worktree_base": "../app1-worktrees"
|
|
42
|
+
"worktree_base": "../app1-specdojo-worktrees"
|
|
43
43
|
}
|
|
44
44
|
}
|
|
45
45
|
}
|
|
@@ -48,13 +48,16 @@ SpecDojo Configuration Reference
|
|
|
48
48
|
|
|
49
49
|
この構成では `config init`、`register scaffold` / `add` / `build`、`dashboard build`、`exec plan --register` を利用できます。catalog へ進むときは `catalog_path`、schedule へ進むときは後述の関連キーを段階的に追加します。
|
|
50
50
|
|
|
51
|
+
最小構成は `repos` を含みません。プロダクトリポジトリ(既定の別リポジトリ構成では `../app1`)をタスクの変更対象にする場合は、`config init` の次の手順の案内に従い、後述の「`repos`のキー」を追加します。生成時に存在しないリポジトリを宣言すると設定の読み込みがエラーになるため、雛形には書き込みません。
|
|
52
|
+
|
|
51
53
|
## 2. トップレベルのキー
|
|
52
54
|
|
|
53
|
-
| キー
|
|
54
|
-
|
|
|
55
|
-
| `version`
|
|
56
|
-
| `current_project`
|
|
57
|
-
| `
|
|
55
|
+
| キー | 必須 | 既定値 | 役割・利用箇所 |
|
|
56
|
+
| -------------------- | ---- | -------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
|
57
|
+
| `version` | 必須 | なし。現行値は `1` | 設定形式のバージョンです。すべての config 利用コマンドが検証します。 |
|
|
58
|
+
| `current_project` | 任意 | コマンドにより `projects` の先頭を使用 | `--project` と `SPECDOJO_PROJECT` を省略したときの対象 project です。 |
|
|
59
|
+
| `agent_members_path` | 任意 | `.specdojo/agent-members.yaml` | 全 project が共有する保護済み agent 定義です。`.specdojo/` 配下の YAML だけを指定できます。 |
|
|
60
|
+
| `projects` | 必須 | なし | project ID をキー、project 設定を値とするオブジェクトです。複数 project を1ファイルで扱えます。 |
|
|
58
61
|
|
|
59
62
|
対象 project の一般的な解決順序は、`--project <id>`、`SPECDOJO_PROJECT`、`current_project`、`projects` の先頭です。一部のコマンドは `current_project` を参照せず `projects` の先頭へフォールバックするため、複数 project では `--project` を明示してください。
|
|
60
63
|
|
|
@@ -62,19 +65,19 @@ SpecDojo Configuration Reference
|
|
|
62
65
|
|
|
63
66
|
`projects.<project-id>` に指定するキーです。`base_path` 以外の表中のパスは、`base_path` があればそこからの相対パス、無ければリポジトリルートからの相対パスとして解決します。
|
|
64
67
|
|
|
65
|
-
| キー | 既定値 | 主な役割
|
|
66
|
-
| ----------------------- | ---------------- |
|
|
67
|
-
| `base_path` | リポジトリルート | project 文書に共通するパス接頭辞
|
|
68
|
-
| `project_register_path` | なし | 個票、event、登録簿の配置先
|
|
69
|
-
| `catalog_path` | なし | `dct-*.yaml` と生成ビューの配置先
|
|
70
|
-
| `schedule_path` | `schedule` | strategy、track、Schedule の配置先
|
|
71
|
-
| `execution_path` | `execution` | plan、result、実行状態、grade / Job Run の配置先
|
|
72
|
-
| `timeline_path` | `timeline` | Timeline の正本と生成物の配置先
|
|
73
|
-
| `members_path` | なし |
|
|
74
|
-
| `roles_path` | なし | role 定義ファイルの配置先
|
|
75
|
-
| `viewpoints_path` | なし | review / grade 観点ファイルの配置先
|
|
76
|
-
| `routines_path` | なし | `rtn-*.yaml` と routine 状態の配置先
|
|
77
|
-
| `jobs_path` | なし | `job-*.yaml` の配置先
|
|
68
|
+
| キー | 既定値 | 主な役割 | 必要とする主なコマンド |
|
|
69
|
+
| ----------------------- | ---------------- | ------------------------------------------------- | ------------------------------------------------------------- |
|
|
70
|
+
| `base_path` | リポジトリルート | project 文書に共通するパス接頭辞 | project に紐づく各コマンド |
|
|
71
|
+
| `project_register_path` | なし | 個票、event、登録簿の配置先 | `register *`、`exec plan/run --register` |
|
|
72
|
+
| `catalog_path` | なし | `dct-*.yaml` と生成ビューの配置先 | `catalog *`、`deliverable scaffold`、catalog を使う grade 等 |
|
|
73
|
+
| `schedule_path` | `schedule` | strategy、track、Schedule の配置先 | `schedule *`、schedule 対象の `exec *` |
|
|
74
|
+
| `execution_path` | `execution` | plan、result、実行状態、grade / Job Run の配置先 | `exec *`、`grade *`、`job *`、`dashboard build` |
|
|
75
|
+
| `timeline_path` | `timeline` | Timeline の正本と生成物の配置先 | `timeline *`、`dashboard build`、`schedule strategy generate` |
|
|
76
|
+
| `members_path` | なし | 人間と対応 Role code を定義する `pm-members.yaml` | actor 検証、owner 検証、合成名簿の project 側入力 |
|
|
77
|
+
| `roles_path` | なし | role 定義ファイルの配置先 | `schedule strategy generate`、owner を解決する `exec plan` |
|
|
78
|
+
| `viewpoints_path` | なし | review / grade 観点ファイルの配置先 | `grade *`、review plan、`exec scaffold --project` |
|
|
79
|
+
| `routines_path` | なし | `rtn-*.yaml` と routine 状態の配置先 | `routine *`、routine を集約する `dashboard build` |
|
|
80
|
+
| `jobs_path` | なし | `job-*.yaml` の配置先 | `job *`、`exec run --job` |
|
|
78
81
|
|
|
79
82
|
`schedule_path`、`execution_path`、`timeline_path` には解決時の既定値があります。ただし `schedule` コマンドや一括 `build` の対象判定ではキーの明示が必要なため、catalog から Schedule と exec へ進む構成では省略しないでください。
|
|
80
83
|
|
|
@@ -84,6 +87,7 @@ SpecDojo Configuration Reference
|
|
|
84
87
|
| ----------------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
85
88
|
| `project_context` | `["prj-overview"]` | edit / review plan へ常に渡す project 共通文書のローカル ID です。空配列 `[]` で無効化できます。`depends_on` や成果物の `based_on` は変更しません。 |
|
|
86
89
|
| `run` | `{}` | agent 実行、worktree、登録日の表示に関する project 単位の設定です。 |
|
|
90
|
+
| `repos` | なし | project のタスクが変更するプロダクトリポジトリの宣言です。詳細は「`repos`のキー」を参照してください。 |
|
|
87
91
|
|
|
88
92
|
## 5. `run`のキー
|
|
89
93
|
|
|
@@ -96,12 +100,91 @@ SpecDojo Configuration Reference
|
|
|
96
100
|
| `worktree_base` | `../worktrees` | `exec run --worktree` / `--auto` と `exec trial` が作る worktree の親です。リポジトリ外を指定します。 |
|
|
97
101
|
| `register_date_timezone` | `UTC` | 登録簿の「登録日」「完了日」を日時から暦日へ変換する IANA タイムゾーン名です。例は `Asia/Tokyo` です。 |
|
|
98
102
|
|
|
99
|
-
`config init`
|
|
103
|
+
`config init` は一般既定の `../worktrees` ではなく、実行したリポジトリのディレクトリ名から作る `../<リポジトリ名>-worktrees` を `worktree_base` へ明示します。例えば `app1-specdojo/` で実行した場合は `../app1-specdojo-worktrees` です。
|
|
104
|
+
|
|
105
|
+
`config init` は、設定した配置から生成物を除外する `.gitignore` の行も導きます。既定の行は `node_modules/`、`.specdojo/doc-index.json`、`docs/**/generated/*`、`!docs/**/generated/.gitkeep`、`docs/**/execution/exec/.locks/` です。`base_path` が `docs/` の外にある場合は `<base_path>/**/generated/*` などを追加し、`base_path` が無い場合は各パス設定から導いた行を追加します。リポジトリ外を指すパスは対象にしません。配置を変えた後は `config init` を再実行すると、足りない行だけが追記されます。
|
|
106
|
+
|
|
107
|
+
## 6. `repos`のキー
|
|
108
|
+
|
|
109
|
+
`projects.<project-id>.repos` は、プロジェクトリポジトリとは別のプロダクトリポジトリを配列で宣言します。プロジェクトリポジトリ自身は宣言しません。キーを省略した project(または空配列)は、従来どおりプロジェクトリポジトリ 1 つだけを扱います。
|
|
110
|
+
|
|
111
|
+
| キー | 必須 | 既定値 | 役割・利用箇所 |
|
|
112
|
+
| -------------------- | ---- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
113
|
+
| `name` | 必須 | なし | `targets`・`paths` の接頭辞に使うリポジトリ名です。`[a-z0-9-]` だけを使い、project 内で一意です。`project` は予約名で使えません。 |
|
|
114
|
+
| `path` | 必須 | なし | リポジトリのルートです。SpecDojo ルートからの相対パスで書き、実在するディレクトリを指します。 |
|
|
115
|
+
| `integration_branch` | 任意 | そのリポジトリの現在のブランチ | exec が変更を統合する先のブランチです。exec branch もこのブランチの先端から作ります。 |
|
|
116
|
+
| `setup` | 任意 | 両方 `true` | worktree 作成時の準備の有無です。`install`(依存導入)と `build`(生成物の build)を真偽値で指定します。 |
|
|
117
|
+
|
|
118
|
+
```json
|
|
119
|
+
{
|
|
120
|
+
"base_path": "docs/ja/projects/prj-0001",
|
|
121
|
+
"project_register_path": "controls/project-register",
|
|
122
|
+
"repos": [
|
|
123
|
+
{
|
|
124
|
+
"name": "app1",
|
|
125
|
+
"path": "../app1",
|
|
126
|
+
"integration_branch": "main",
|
|
127
|
+
"setup": { "install": true, "build": false }
|
|
128
|
+
}
|
|
129
|
+
]
|
|
130
|
+
}
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
`targets`(個票・job)と `paths`(job)では、`<repo>:<path>`(例: `app1:src/auth/token.ts`)でプロダクトリポジトリ内のパスを指定します。値の区別は次の規則に従います。
|
|
134
|
+
|
|
135
|
+
- `:` より前の接頭辞が宣言済みのリポジトリ名なら、そのリポジトリのルートからの相対パスとして扱います。空のパス、絶対パス、リポジトリの外へ出るパス(`..` を含むもの)はエラーです。
|
|
136
|
+
- それ以外の値は従来どおりです。`targets` では doc id(例: `prj-0001:pjr-index`、`ifx-cmd`)、`paths` ではプロジェクトリポジトリ内のパスとして扱います。
|
|
137
|
+
- プロダクトリポジトリの文書は doc id では引けません。パスで指定します。
|
|
100
138
|
|
|
101
|
-
|
|
139
|
+
`setup` の `install` は追跡済みの `package-lock.json` ごとの `npm ci`、`build` はリポジトリに `.specdojo/specdojo.config.json` がある場合の `specdojo build` です。対象が無いリポジトリでは、`true` でも何も実行しません。
|
|
140
|
+
|
|
141
|
+
`repos` を宣言した project の `exec run --worktree` と `exec worktree prepare` は、タスクごとに次の worktree を作ります。宣言の無い project は従来どおり `<worktree_base>/<task-id>/` の直下に 1 つだけ作ります。
|
|
142
|
+
|
|
143
|
+
- `<worktree_base>/<task-id>/project/`: プロジェクトリポジトリの worktree です。agent の作業ディレクトリ(`cwd`)になります。`project` が予約名なのはこのためです。
|
|
144
|
+
- `<worktree_base>/<task-id>/<name>/`: 宣言した各リポジトリの worktree です。exec branch は `integration_branch`(省略時は現在のブランチ)の先端から作ります。
|
|
145
|
+
|
|
146
|
+
agent には、各 worktree の絶対パスを次の環境変数で渡します。
|
|
147
|
+
|
|
148
|
+
| 環境変数 | 値 |
|
|
149
|
+
| ----------------------- | ----------------------------------------------------- |
|
|
150
|
+
| `SPECDOJO_REPO_PROJECT` | プロジェクトリポジトリの worktree |
|
|
151
|
+
| `SPECDOJO_REPO_<NAME>` | `<name>` の worktree。`<NAME>` は大文字で、`-` は `_` |
|
|
152
|
+
| `SPECDOJO_REPO_NAMES` | 宣言したリポジトリ名を宣言順にカンマで区切ったもの |
|
|
153
|
+
|
|
154
|
+
agent の起動コマンドには、provider ごとにプロダクト worktree への書き込み許可を runner が付け足します。`exec-defaults.yaml` の `command_template` を変える必要はありません。
|
|
155
|
+
|
|
156
|
+
| provider | 付け足す引数 | 制約 |
|
|
157
|
+
| ------------- | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
|
158
|
+
| `claude` | `--add-dir <path>...` と `--allowedTools 'Edit(//<path>/**)'...` | mode 別 settings の `Edit` 許可は作業ディレクトリ相対のため、絶対パスの許可を別に渡す |
|
|
159
|
+
| `codex` | `--add-dir <path>`(リポジトリの数だけ) | `--sandbox workspace-write` の書き込みルートに加わる。`.git` は codex の仕様で読み取り専用のまま |
|
|
160
|
+
| `antigravity` | `--add-dir <path>`(リポジトリの数だけ) | テンプレートの `--add-dir "$(pwd)"` に追加する |
|
|
161
|
+
| `copilot` | `--add-dir <path>`(リポジトリの数だけ) | 書き込みはテンプレートの `--allow-tool write` に従う |
|
|
162
|
+
| `opencode` | なし | 作業ディレクトリ外は agent 定義の `permission.external_directory` で拒否される。許可には agent 定義の変更が必要になる |
|
|
163
|
+
|
|
164
|
+
対話型オーケストレーターは `specdojo orchestrator launch` が同じ `repos` を読み、プロダクトリポジトリ本体のルートを許可します。Claude Code、Codex、Antigravity、GitHub Copilot は上表と同じ引数規則です。OpenCode は起動時の inline config で、選択 agent の `permission.external_directory` を「全拒否、宣言済みルートだけ許可」に差し替え、宣言済みルートの `permission.edit` も許可します。この設定はオーケストレーターのプロセスだけに適用され、agent 定義や利用者の設定ファイルは書き換えません。`repos` を省略した project では追加の引数・設定を渡しません。
|
|
165
|
+
|
|
166
|
+
agent 実行の前後で行う保護設定(`package.json`、CI 設定など)と Git 状態(HEAD・ローカル設定)の検査は、プロダクト worktree にも同じ一覧で行います。evidence の変更ファイルは、プロダクト側を `<name>:<path>` で記録します。
|
|
167
|
+
|
|
168
|
+
プロダクトリポジトリの変更は、`exec run --worktree` の統合段で runner がリポジトリごとに commit し、宣言順のプロダクト、最後にプロジェクトの順で統合します。統合の順序、失敗時の部分状態、再開は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] の「複数リポジトリの worktree と統合順序」と「複数リポジトリの統合の失敗と再開」を参照してください。`exec worktree commit` はプロダクト側を統合しないため、プロダクト worktree に未 commit の変更か exec branch の commit が残るタスクは、プロジェクト側の commit の前に停止します。撤去は、全リポジトリの worktree が撤去できることを確かめてからまとめて行います。
|
|
169
|
+
|
|
170
|
+
exec worktree の中で設定を読む場合(agent が worktree で `specdojo` を実行する場合など)、`path` の代わりに同じタスクの `<worktree_base>/<task-id>/<name>/` へ解決します。
|
|
171
|
+
|
|
172
|
+
設定の読み込み時に、次の誤りを対象(`projects.<project-id>.repos[<n>]`)と原因を示すエラーにします。誤りは全 project 分をまとめて表示します。
|
|
173
|
+
|
|
174
|
+
- `name` が `[a-z0-9-]` 以外の文字を含む、または同じ project 内で重複している。
|
|
175
|
+
- `name` がいずれかの project ID と同じである。`<name>:<...>` が doc id とリポジトリのパスのどちらか区別できなくなるためです。
|
|
176
|
+
- `name` が予約名 `project` である。プロジェクトリポジトリの worktree のディレクトリ名と重なるためです。
|
|
177
|
+
- `path` が空、絶対パス、存在しない、またはディレクトリでない。
|
|
178
|
+
- 宣言に無いキーがある、`integration_branch` が空文字、`setup` の値が真偽値でない。
|
|
179
|
+
|
|
180
|
+
設定の形は `docs/specdojo/schemas/v1/specdojo-config.schema.yaml` でも検証できます。リポジトリ名と project ID の重複と `path` の実在は schema で表せないため、CLI の読み込み時の検証が正本です。
|
|
181
|
+
|
|
182
|
+
## 7. catalog・schedule・execへ進む設定例
|
|
102
183
|
|
|
103
184
|
register の最小構成から成果物カタログと Schedule へ進む場合は、対象 project へ必要なキーを追加します。次は Quick Start の代表例です。
|
|
104
185
|
|
|
186
|
+
agent 実行を使う場合は、この project オブジェクトとは別にトップレベルへ `"agent_members_path": ".specdojo/agent-members.yaml"` を指定できます。省略時も同じパスが既定です。
|
|
187
|
+
|
|
105
188
|
```json
|
|
106
189
|
{
|
|
107
190
|
"base_path": "docs/ja/projects/prj-0001",
|
|
@@ -116,14 +199,14 @@ register の最小構成から成果物カタログと Schedule へ進む場合
|
|
|
116
199
|
"project_context": ["prj-overview"],
|
|
117
200
|
"run": {
|
|
118
201
|
"exec_defaults": ".specdojo/exec-defaults.yaml",
|
|
119
|
-
"worktree_base": "../app1-worktrees"
|
|
202
|
+
"worktree_base": "../app1-specdojo-worktrees"
|
|
120
203
|
}
|
|
121
204
|
}
|
|
122
205
|
```
|
|
123
206
|
|
|
124
207
|
routine / Job を使う段階で、同じ project 設定へ `routines_path` と `jobs_path` を追加します。未使用のキーまで最初から埋める必要はありません。
|
|
125
208
|
|
|
126
|
-
##
|
|
209
|
+
## 8. 設定不足時の確認順序
|
|
127
210
|
|
|
128
211
|
1. エラーに表示されたキーが対象 project にあるか確認します。
|
|
129
212
|
2. `base_path` と対象パスを連結した先が意図した配置か確認します。
|