specdojo 0.7.0 → 0.8.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.
- package/.github/agents/specdojo-orchestrator.md +3 -2
- package/CHANGELOG.md +153 -0
- package/dist/catalog/build.js +24 -1
- package/dist/catalog/plan.js +1 -1
- package/dist/catalog/scaffold.js +4 -1
- package/dist/commands/init.js +5 -1
- package/dist/commands/night-orchestrator.js +6 -4
- package/dist/dashboard/dashboard-timeline.js +18 -16
- package/dist/dashboard/dashboard.js +612 -259
- package/dist/dashboard/epic-plan.js +81 -0
- package/dist/dashboard/exec-records.js +16 -20
- package/dist/dashboard/routines.js +8 -6
- package/dist/dashboard/timeline-build.js +5 -9
- package/dist/dashboard/timeline.js +9 -4
- package/dist/devcontainer/scaffold.js +18 -0
- package/dist/docs/frontmatter-namespace.js +1 -48
- package/dist/docs/yaml-pages.js +125 -3
- package/dist/exec/agent-config.js +22 -0
- package/dist/exec/agent-plan.js +3 -2
- package/dist/exec/commands.js +69 -21
- package/dist/exec/commit-hook-skips.js +78 -0
- package/dist/exec/core.js +19 -7
- package/dist/exec/events.js +159 -8
- package/dist/exec/evidence.js +64 -16
- package/dist/exec/handoff.js +9 -13
- package/dist/exec/limit.js +1 -1
- package/dist/exec/mechanical-result.js +45 -0
- package/dist/exec/migrate-records.js +249 -0
- package/dist/exec/parent-validation.js +153 -12
- package/dist/exec/pipeline-state.js +27 -5
- package/dist/exec/plans-condense-findings.js +89 -0
- package/dist/exec/plans-core.js +24 -17
- package/dist/exec/plans-generation.js +48 -25
- package/dist/exec/plans-grade-findings.js +8 -3
- package/dist/exec/plans-kata-findings.js +61 -0
- package/dist/exec/plans-planning.js +3 -3
- package/dist/exec/plans-storage.js +12 -24
- package/dist/exec/register-resume.js +55 -56
- package/dist/exec/register.js +26 -22
- package/dist/exec/repo-integration-sync.js +8 -4
- package/dist/exec/repo-integration.js +21 -1
- package/dist/exec/reporter.js +121 -23
- package/dist/exec/results.js +85 -24
- package/dist/exec/review-completion.js +47 -0
- package/dist/exec/review-kata.js +109 -0
- package/dist/exec/run/agent-pipeline.js +75 -6
- package/dist/exec/run/agent.js +20 -7
- package/dist/exec/run/in-place.js +69 -32
- package/dist/exec/run/job.js +81 -24
- package/dist/exec/run/lifecycle-commands.js +188 -36
- package/dist/exec/run/mode-shared.js +11 -3
- package/dist/exec/run/register-command.js +6 -10
- package/dist/exec/run/register-core.js +20 -13
- package/dist/exec/run/register-mode.js +12 -12
- package/dist/exec/run/register-post-review.js +21 -9
- package/dist/exec/run/register-resume.js +28 -18
- package/dist/exec/run/register-state.js +10 -7
- package/dist/exec/run/register-worktree.js +60 -30
- package/dist/exec/run/schedule-mode.js +4 -4
- package/dist/exec/run/schedule-prepare.js +201 -59
- package/dist/exec/run/schedule-task.js +129 -25
- package/dist/exec/run/shared.js +4 -3
- package/dist/exec/run/trailing-records.js +35 -0
- package/dist/exec/run-records.js +2 -0
- package/dist/exec/strategy.js +1 -0
- package/dist/exec/trailing-records.js +242 -0
- package/dist/exec/trial-commands.js +3 -2
- package/dist/exec/validate-records-commit.js +110 -0
- package/dist/exec/validate-records.js +148 -0
- package/dist/exec/worktree-command.js +29 -16
- package/dist/exec/worktree-ops-commit.js +119 -48
- package/dist/exec/worktree-ops-lifecycle.js +77 -48
- package/dist/exec/worktree-ops-merge.js +13 -2
- package/dist/exec/worktree-ops.js +2 -2
- package/dist/exec/worktree.js +19 -2
- package/dist/grade/apply.js +32 -6
- package/dist/grade/command-inspect.js +2 -2
- package/dist/grade/command-run.js +2 -0
- package/dist/grade/command-shared.js +1 -1
- package/dist/grade/core.js +18 -5
- package/dist/grade/markdown.js +3 -3
- package/dist/grade/pipeline-state.js +15 -11
- package/dist/grade/plan.js +37 -17
- package/dist/grade/result.js +3 -3
- package/dist/grade/run.js +23 -3
- package/dist/grade/target-discovery.js +17 -4
- package/dist/grade/targets.js +12 -11
- package/dist/job/job.js +31 -17
- package/dist/job/noop.js +104 -0
- package/dist/register/core.js +2 -0
- package/dist/register/create-commands.js +28 -3
- package/dist/register/deliverable-target.js +9 -1
- package/dist/register/epic.js +104 -26
- package/dist/register/event-merge.js +3 -0
- package/dist/register/events.js +4 -0
- package/dist/register/external-project.js +3 -0
- package/dist/register/item.js +6 -0
- package/dist/register/maintenance-commands.js +4 -1
- package/dist/register/planning.js +7 -14
- package/dist/register/register.js +43 -9
- package/dist/register/track-domains.js +34 -0
- package/dist/register/track-plan.js +78 -0
- package/dist/register/transition-commands.js +8 -0
- package/dist/register/work-table.js +64 -0
- package/dist/review/grade.js +35 -13
- package/dist/routine/definition.js +4 -3
- package/dist/routine/failure.js +30 -0
- package/dist/routine/routine.js +56 -32
- package/dist/routine/storage.js +33 -0
- package/dist/schedule/schedule.js +1 -0
- package/dist/schedule/strategy-generate-document.js +26 -14
- package/dist/schedule/strategy-generate-scope.js +17 -45
- package/dist/schedule/strategy-generate.js +33 -3
- package/dist/schedule/strategy-profiles.js +86 -12
- package/dist/shared/agent-types.js +2 -0
- package/dist/shared/condense-records.js +25 -0
- package/dist/shared/deprecation.js +8 -0
- package/dist/shared/document-metadata.js +20 -0
- package/dist/shared/finding-cause.js +20 -0
- package/dist/shared/frontmatter-namespace.js +48 -0
- package/dist/shared/git.js +142 -15
- package/dist/shared/grade-result.js +17 -1
- package/dist/shared/local-state.js +20 -0
- package/dist/shared/markdownlint-config.js +8 -3
- package/dist/shared/plan-conventions.js +129 -0
- package/dist/shared/plan-templates.js +57 -41
- package/dist/shared/run-records.js +224 -0
- package/dist/shared/specdojo-config.js +39 -21
- package/dist/shared/text.js +65 -5
- package/dist/shared/timeline-index.js +2 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +9 -2
- package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +4 -74
- package/docs/ja/specdojo/exec-templates/xep-condense-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xep-draft-template.md +17 -5
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +16 -3
- package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +15 -5
- package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-register-template.md +1 -1
- package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xer-condense-template.md +25 -0
- package/docs/ja/specdojo/exec-templates/xp-common-conventions-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xrp-common-conventions-template.md +30 -0
- package/docs/ja/specdojo/guides/branch-workflow-guide.md +1 -1
- package/docs/ja/specdojo/guides/docs-editing-guide.md +12 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +48 -15
- package/docs/ja/specdojo/guides/exec-config-guide.md +47 -16
- package/docs/ja/specdojo/guides/exec-operation-guide.md +53 -17
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +92 -55
- package/docs/ja/specdojo/guides/project-move-guide.md +381 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +70 -14
- package/docs/ja/specdojo/guides/register-operation-guide.md +25 -5
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +2 -0
- package/docs/ja/specdojo/guides/review-guide.md +22 -19
- package/docs/ja/specdojo/guides/routine-operation-guide.md +14 -8
- package/docs/ja/specdojo/guides/ryu-guide.md +23 -13
- package/docs/ja/specdojo/guides/schedule-design-guide.md +7 -4
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +27 -3
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +5 -4
- package/docs/ja/specdojo/guides/timeline-design-guide.md +27 -144
- package/docs/ja/specdojo/guides/use-case-guide.md +92 -155
- package/docs/ja/specdojo/recipes/bac-recipe.md +94 -0
- package/docs/ja/specdojo/recipes/bes-recipe.md +105 -0
- package/docs/ja/specdojo/recipes/br-recipe.md +84 -0
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +36 -24
- package/docs/ja/specdojo/recipes/cnd-recipe.md +125 -0
- package/docs/ja/specdojo/recipes/cpd-recipe.md +126 -0
- package/docs/ja/specdojo/recipes/cxd-recipe.md +145 -0
- package/docs/ja/specdojo/recipes/ifd-recipe.md +134 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +135 -86
- package/docs/ja/specdojo/recipes/ifx-index-recipe.md +130 -0
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +29 -26
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +35 -26
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +38 -28
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -31
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +26 -28
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +10 -8
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +18 -17
- package/docs/ja/specdojo/recipes/stsd-recipe.md +100 -62
- package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +106 -0
- package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +137 -0
- package/docs/ja/specdojo/recipes/sysd-index-recipe.md +122 -0
- package/docs/ja/specdojo/references/command-reference.md +79 -64
- package/docs/ja/specdojo/references/deliverables-reference.md +9 -4
- package/docs/ja/specdojo/references/directory-layout-reference.md +3 -2
- package/docs/ja/specdojo/references/specdojo-config-reference.md +17 -16
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +72 -290
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +212 -79
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +138 -154
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +147 -59
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +100 -96
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +88 -108
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +126 -211
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +56 -35
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +102 -68
- package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +152 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +9 -184
- package/docs/ja/specdojo/rulebooks/clis-rulebook.md +187 -0
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +93 -247
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +104 -241
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +124 -257
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +87 -98
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +9 -7
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/dss-rulebook.md +193 -0
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +100 -54
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +69 -252
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +91 -76
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +252 -226
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +118 -40
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +11 -11
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +9 -9
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +4 -4
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +11 -11
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +11 -11
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +4 -3
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +34 -29
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +8 -8
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +2 -2
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +50 -56
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +46 -55
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +57 -54
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +50 -65
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +2 -2
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +70 -97
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +47 -56
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +61 -135
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +116 -32
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +118 -61
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +152 -57
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +51 -39
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +101 -46
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +72 -329
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +74 -263
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +78 -195
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +4 -9
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +3 -4
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +3 -3
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +140 -143
- package/docs/ja/specdojo/samples/bac-sample.md +106 -21
- package/docs/ja/specdojo/samples/bdd-sample.yaml +143 -35
- package/docs/ja/specdojo/samples/bds-sample.md +100 -21
- package/docs/ja/specdojo/samples/bes-index-sample.md +59 -20
- package/docs/ja/specdojo/samples/bes-sample.md +80 -21
- package/docs/ja/specdojo/samples/br-sample.md +68 -14
- package/docs/ja/specdojo/samples/ccd-sample.md +81 -19
- package/docs/ja/specdojo/samples/cdfd-sample.md +172 -99
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +9 -7
- package/docs/ja/specdojo/samples/cdsd-sample.md +89 -20
- package/docs/ja/specdojo/samples/cdt-sample.md +116 -0
- package/docs/ja/specdojo/samples/cld-sample.md +3 -30
- package/docs/ja/specdojo/samples/clis-sample.md +132 -0
- package/docs/ja/specdojo/samples/cnd-sample.md +127 -21
- package/docs/ja/specdojo/samples/cpd-sample.md +136 -22
- package/docs/ja/specdojo/samples/cxd-sample.md +108 -22
- package/docs/ja/specdojo/samples/dct-index-sample.yaml +63 -17
- package/docs/ja/specdojo/samples/dss-sample.md +175 -0
- package/docs/ja/specdojo/samples/gl-sample.yaml +50 -14
- package/docs/ja/specdojo/samples/ifd-sample.md +105 -21
- package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +91 -60
- package/docs/ja/specdojo/samples/ifx-file-sample.md +462 -21
- package/docs/ja/specdojo/samples/ifx-index-sample.yaml +87 -19
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +37 -13
- package/docs/ja/specdojo/samples/pm-organization-sample.md +52 -20
- package/docs/ja/specdojo/samples/pm-plan-sample.md +84 -26
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +55 -22
- package/docs/ja/specdojo/samples/pm-raci-sample.md +69 -28
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +13 -12
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +50 -26
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +89 -62
- package/docs/ja/specdojo/samples/sf-index-sample.md +89 -20
- package/docs/ja/specdojo/samples/sf-sample.md +121 -21
- package/docs/ja/specdojo/samples/sld-sample.md +107 -21
- package/docs/ja/specdojo/samples/stsd-sample.md +54 -26
- package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +166 -21
- package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +178 -21
- package/docs/ja/specdojo/samples/sysd-index-sample.md +82 -21
- package/docs/ja/specdojo/samples/tml-sample.yaml +4 -1
- package/docs/ja/specdojo/samples/uis-sample.md +164 -20
- package/docs/ja/specdojo/standards/document-metadata-standard.md +33 -4
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +3 -1
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +1 -0
- package/docs/ja/specdojo/templates/bac-template.md +76 -0
- package/docs/ja/specdojo/templates/bes-template.md +56 -0
- package/docs/ja/specdojo/templates/br-template.md +64 -0
- package/docs/ja/specdojo/templates/cdfd-template.md +81 -54
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +9 -5
- package/docs/ja/specdojo/templates/cnd-template.md +137 -0
- package/docs/ja/specdojo/templates/cpd-template.md +129 -0
- package/docs/ja/specdojo/templates/cxd-template.md +105 -0
- package/docs/ja/specdojo/templates/dct-data-model-cdt-template.yaml +40 -0
- package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +7 -14
- package/docs/ja/specdojo/templates/dct-index-template.md +9 -20
- package/docs/ja/specdojo/templates/dct-project-management-template.yaml +5 -1
- package/docs/ja/specdojo/templates/ifd-template.md +86 -0
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +44 -28
- package/docs/ja/specdojo/templates/ifx-index-template.yaml +40 -0
- package/docs/ja/specdojo/templates/opr-template.md +2 -4
- package/docs/ja/specdojo/templates/pm-organization-template.md +9 -3
- package/docs/ja/specdojo/templates/pm-plan-template.md +4 -4
- package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +17 -9
- package/docs/ja/specdojo/templates/pm-raci-template.md +24 -13
- package/docs/ja/specdojo/templates/pm-roles-template.yaml +3 -2
- package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +6 -3
- package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +22 -19
- package/docs/ja/specdojo/templates/stsd-template.md +46 -21
- package/docs/ja/specdojo/templates/sysd-critical-flows-template.md +94 -0
- package/docs/ja/specdojo/templates/sysd-cross-cutting-policy-template.md +122 -0
- package/docs/ja/specdojo/templates/sysd-index-template.md +89 -0
- package/docs/specdojo/lib/yaml-metadata.cjs +7 -0
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +25 -57
- package/docs/specdojo/schemas/v1/condense-records.schema.yaml +26 -0
- package/docs/specdojo/schemas/v1/dct.schema.yaml +10 -0
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/esil.schema.yaml +7 -141
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +53 -3
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +14 -0
- package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/finding-cause.schema.yaml +22 -0
- package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +1 -1
- package/docs/specdojo/schemas/v1/grade-result.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +65 -5
- package/docs/specdojo/schemas/v1/ifx-index.schema.yaml +142 -0
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +17 -1
- package/package.json +2 -2
- package/templates/antigravity/orchestrator.md +3 -2
- package/templates/claude/agents/specdojo-orchestrator.md +3 -2
- package/templates/codex/agents/specdojo-orchestrator.toml +3 -2
- package/templates/codex/orchestrator.md +3 -2
- package/templates/devcontainer/tmux.conf +6 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +3 -2
|
@@ -0,0 +1,381 @@
|
|
|
1
|
+
---
|
|
2
|
+
specdojo:
|
|
3
|
+
id: specdojo:project-move-guide
|
|
4
|
+
type: guide
|
|
5
|
+
status: draft
|
|
6
|
+
based_on:
|
|
7
|
+
- specdojo:specdojo-overview-guide
|
|
8
|
+
- specdojo:specdojo-config-reference
|
|
9
|
+
- specdojo:branch-workflow-guide
|
|
10
|
+
- specdojo:id-and-file-naming-standard
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# プロジェクト移行ガイド
|
|
14
|
+
|
|
15
|
+
Project Move Guide
|
|
16
|
+
|
|
17
|
+
同一リポジトリで管理していた SpecDojo プロジェクト(`prj-xxxx`)を、独立した管理用リポジトリ(別リポジトリ構成)へ安全に切り出して移す手順を説明します。
|
|
18
|
+
|
|
19
|
+
**対象読者**
|
|
20
|
+
|
|
21
|
+
- 同一リポジトリで運用していた project を、独立した管理用リポジトリ(別リポジトリ構成)へ切り出したい開発者、リポジトリ管理者、運用者
|
|
22
|
+
|
|
23
|
+
**この文書で分かること**
|
|
24
|
+
|
|
25
|
+
- `git subtree split` による履歴の切り出し、Kata の npm パッケージ版固定、設定の移行と元リポジトリからの削除、`external_projects` による相互起票連携、文書サイトからの除外手順、および取り返しのつかない操作の前の確認ポイントと戻し方
|
|
26
|
+
|
|
27
|
+
**次に読む文書**
|
|
28
|
+
|
|
29
|
+
- 設定項目の詳細は [[specdojo:specdojo-config-reference|SpecDojo設定リファレンス]] を参照してください。
|
|
30
|
+
- ブランチ構成や Git 操作の標準は [[specdojo:branch-workflow-guide|ブランチワークフローガイド]] を参照してください。
|
|
31
|
+
- プロジェクトとプロダクトの構成原則は [[specdojo:specdojo-overview-guide|全体概要ガイド]] を参照してください。
|
|
32
|
+
|
|
33
|
+
## 1. 移行の概要と基本方針
|
|
34
|
+
|
|
35
|
+
### 1.1. 背景と目的
|
|
36
|
+
|
|
37
|
+
SpecDojo では、同一リポジトリ内でプロダクトコードと複数のプロジェクト(`prj-xxxx`)を管理する同一リポジトリ構成と、プロジェクト管理文書(登録簿・計画・実行記録)を独立した専用リポジトリに置く別リポジトリ構成を選択できます。
|
|
38
|
+
|
|
39
|
+
初期段階では手軽な同一リポジトリ構成で開始しても、プロジェクトの成長に伴い「プロダクトの変更履歴と管理作業の記帳 commit を分離したい」「管理リポジトリを独立させて権限や CI 実行環境を切り離したい」という要求が生じます。
|
|
40
|
+
|
|
41
|
+
本ガイドでは、同一リポジトリ内の `prj-0002`(例: LP 管理)を別リポジトリ(例: `../specdojo-lp-specdojo`)へ移すシナリオを例として、安全に段階的に移行する標準手順を示します。説明中のパスやリポジトリ名は例示であり、実際のリポジトリは変更しません。
|
|
42
|
+
|
|
43
|
+
### 1.2. 移行の全体フロー
|
|
44
|
+
|
|
45
|
+
移行は以下の 5 つのステップで進めます。
|
|
46
|
+
|
|
47
|
+
```mermaid
|
|
48
|
+
flowchart TD
|
|
49
|
+
A["事前準備<br/>クリーン状態確認とバックアップ"] --> B["1. 履歴の切り出し<br/>git subtree split で base_path を抽出"]
|
|
50
|
+
B --> C["2. Kataの版固定<br/>新リポジトリで npm package を参照"]
|
|
51
|
+
C --> D["3. 設定の写しと動作点検<br/>specdojo.config.json 等を配置・点検"]
|
|
52
|
+
D --> E["取り返しのつかない操作の確認<br/>元リポジトリから対象を削除"]
|
|
53
|
+
E --> F["4. 外部起票の宣言<br/>external_projects で相互参照を設定"]
|
|
54
|
+
F --> G["5. 文書サイトからの除外<br/>元サイトのサイドバー・リンク点検"]
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### 1.3. ID と commit Refs の継続性
|
|
58
|
+
|
|
59
|
+
SpecDojo のドキュメント ID、登録簿項目 ID(`PJR-xxxx`)、コミットメッセージ末尾の `Refs: <project-id>:<ID>` は、プロジェクト ID(`prj-0002`)を変更しなければ、別リポジトリへ移した後もそのまま使い続けられます。
|
|
60
|
+
|
|
61
|
+
移行時はプロジェクト ID を維持します。ただし、`git subtree split` が作るコミットの SHA は元のコミットと異なります。SHA を直接指すリンクの参照先として元リポジトリを残し、移行元の先端 SHA と切り出した先端 SHA を移行記録に残してください。
|
|
62
|
+
|
|
63
|
+
### 1.4. 安全原則と取り返しのつかない操作の防止
|
|
64
|
+
|
|
65
|
+
- **共有履歴の書き換え禁止**: 元リポジトリの共有ブランチ(`main` や `develop`)の履歴を改変する操作(`git filter-branch` や強制プッシュを伴う履歴改変)は行いません。`git subtree split` を用いて対象ディレクトリの履歴だけを新ブランチとして抽出します。
|
|
66
|
+
- **削除前の確実な点検**: 元リポジトリから `base_path` や設定を削除する操作は元に戻すのに労力を要します。必ず新リポジトリ側での動作確認を完了してから削除を実行します。
|
|
67
|
+
|
|
68
|
+
## 2. 手順1: 履歴の切り出し (`git subtree split`)
|
|
69
|
+
|
|
70
|
+
対象プロジェクトの `base_path`(例: `docs/ja/projects/prj-0002`)のコミット履歴だけを抽出し、新リポジトリの初期履歴として取り込みます。
|
|
71
|
+
|
|
72
|
+
### 2.1. 前提
|
|
73
|
+
|
|
74
|
+
- 元リポジトリの作業ツリーがクリーンであること(`git status --short` が空)。
|
|
75
|
+
- 移行対象ブランチ(例: `main`)に、移行対象のすべてのコミットがマージされていること。
|
|
76
|
+
- 対象 project の実行中・waiting の登録項目、doing の schedule タスク、exec の worktree・ブランチを確認し、実行や定期起動を止め、未統合の変更を取り込んでいること。`git worktree list` と `git branch --list 'exec/prj-0002-*'` で残存を確認します。
|
|
77
|
+
- 以下のシェル例は Bash で実行し、`../specdojo` が元リポジトリを指す配置であること。新リポジトリのディレクトリと `split-prj-0002` ブランチがまだ存在しないこと。
|
|
78
|
+
- 万一に備え、元リポジトリで移行前の状態にバックアップタグを作成していること。
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
git tag backup-prj-0002-before-move
|
|
82
|
+
git rev-parse HEAD
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### 2.2. 実行するコマンド
|
|
86
|
+
|
|
87
|
+
#### 2.2.1. 元リポジトリで履歴を切り出す
|
|
88
|
+
|
|
89
|
+
対象 `base_path` の履歴を新しい一時ブランチ(`split-prj-0002`)へ抽出します。
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
git subtree split --prefix=docs/ja/projects/prj-0002 -b split-prj-0002
|
|
93
|
+
git rev-parse split-prj-0002
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
#### 2.2.2. 新しい管理用リポジトリを作る
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
mkdir ../specdojo-lp-specdojo
|
|
100
|
+
cd ../specdojo-lp-specdojo
|
|
101
|
+
git init -b main
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
#### 2.2.3. 切り出した履歴を取り込む
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
git fetch ../specdojo split-prj-0002
|
|
108
|
+
git merge --ff-only FETCH_HEAD
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
#### 2.2.4. 元と同じディレクトリ構造へ再配置する
|
|
112
|
+
|
|
113
|
+
抽出直後は旧 `base_path` のファイル群がルートに展開されています。ルートに `move-prj-0002` が存在しないことを確認し、一時ディレクトリを経由して移します。追跡ファイル名は NUL 区切りで読み、空白やドットで始まる名前も保持します。
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
mapfile -d '' -t project_files < <(git ls-tree -z --name-only HEAD)
|
|
117
|
+
mkdir move-prj-0002
|
|
118
|
+
git mv -- "${project_files[@]}" move-prj-0002/
|
|
119
|
+
mkdir -p docs/ja/projects
|
|
120
|
+
git mv move-prj-0002 docs/ja/projects/prj-0002
|
|
121
|
+
git diff --cached --stat
|
|
122
|
+
git commit -m "chore(prj-0002): relocate project root under docs/ja/projects/prj-0002"
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### 2.3. 確かめ方
|
|
126
|
+
|
|
127
|
+
- 新リポジトリ側で `git log --oneline` を実行し、`prj-0002` に関連するコミット履歴だけが正しく引き継がれていることを確認します。
|
|
128
|
+
- 元リポジトリで `git rev-parse backup-prj-0002-before-move:docs/ja/projects/prj-0002`、新リポジトリで `git rev-parse HEAD:docs/ja/projects/prj-0002` を実行し、ツリーの SHA が一致することを確認します。
|
|
129
|
+
- 元リポジトリ側で `git status` および `git log` を確認し、既存のブランチ履歴が一切変更されていないことを確認します。
|
|
130
|
+
|
|
131
|
+
### 2.4. 戻し方
|
|
132
|
+
|
|
133
|
+
- 元リポジトリの共有履歴は変わりません。新リポジトリへの追加作業がなければ、移行用に作成したディレクトリを退避してやり直せます。
|
|
134
|
+
- 一時ブランチは点検が終わるまで残します。削除する場合は対象名と、他の作業で使われていないことを確認します。
|
|
135
|
+
|
|
136
|
+
## 3. 手順2: Kata の版の固定 (npm パッケージ参照)
|
|
137
|
+
|
|
138
|
+
新リポジトリでは Kata(型)の文書群をリポジトリ内に複製せず、npm パッケージ `specdojo` から参照してバージョンを固定します。
|
|
139
|
+
|
|
140
|
+
### 3.1. 前提
|
|
141
|
+
|
|
142
|
+
- Node.js(`>=22.13`)および npm が利用可能な環境であること。
|
|
143
|
+
- 新リポジトリで手順 1 の取り込みが完了していること。
|
|
144
|
+
|
|
145
|
+
### 3.2. 実行するコマンド
|
|
146
|
+
|
|
147
|
+
#### 3.2.1. 新リポジトリのルートで npm を初期化する
|
|
148
|
+
|
|
149
|
+
手順 1 の終了位置(新リポジトリのルート)で実行します。
|
|
150
|
+
|
|
151
|
+
```bash
|
|
152
|
+
npm init -y
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
#### 3.2.2. SpecDojo の版を固定する
|
|
156
|
+
|
|
157
|
+
移行元で利用している版を指定します。以下は `0.7.0` の例です。
|
|
158
|
+
|
|
159
|
+
```bash
|
|
160
|
+
npm install --save-dev --save-exact specdojo@0.7.0
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
`package.json` の値が `^` や `~` を含まないことを確認し、`package-lock.json` とともに管理します。以後の再現には `npm ci` を使います。`specdojo:` の Kata は npm パッケージから解決されるため、旧リポジトリの同梱 Kata をコピーしません。`npx specdojo kata list --kind rulebook` の `SOURCE` が `node_modules` を指すことと、`npx specdojo kata show specdojo:pjr-rulebook` で本文を取得できることを確認します。独自の Kata がある場合は別途移し、既存の authority と ID を維持します。
|
|
164
|
+
|
|
165
|
+
#### 3.2.3. CLI のスクリプトを追加する
|
|
166
|
+
|
|
167
|
+
`package.json` の既存キーを保持し、次のスクリプトを追加します。
|
|
168
|
+
|
|
169
|
+
```json
|
|
170
|
+
{
|
|
171
|
+
"scripts": {
|
|
172
|
+
"specdojo": "specdojo"
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### 3.3. 確かめ方
|
|
178
|
+
|
|
179
|
+
- `npx specdojo --version` を実行し、指定した固定バージョン(例: `0.7.0`)が出力されることを確認します。
|
|
180
|
+
- `npx specdojo help` で CLI コマンド一覧が正常に表示されることを確認します。
|
|
181
|
+
|
|
182
|
+
### 3.4. 戻し方
|
|
183
|
+
|
|
184
|
+
- インストールに関する変更だけを取り消します。既存の `package.json` がある場合はファイル全体を削除せず、移行前の依存定義へ戻して `npm ci` で復元します。
|
|
185
|
+
|
|
186
|
+
## 4. 手順3: 設定の写しと元からの削除
|
|
187
|
+
|
|
188
|
+
プロジェクト固有の設定ファイル(`specdojo.config.json`、名簿、`exec-defaults.yaml` 等)を新リポジトリへ配置し、手動点検を行った後、元リポジトリから対象プロジェクトを削除します。
|
|
189
|
+
|
|
190
|
+
### 4.1. 前提
|
|
191
|
+
|
|
192
|
+
- 手順 1 および手順 2 が正常に完了していること。
|
|
193
|
+
- 新リポジトリで `node_modules` の導入が完了していること。
|
|
194
|
+
|
|
195
|
+
### 4.2. 取り返しのつかない操作の前の確認
|
|
196
|
+
|
|
197
|
+
元リポジトリから `docs/ja/projects/prj-0002` や設定を削除する前に、必ず新リポジトリ側で設定の認識と登録簿の読み込みができることを点検します。
|
|
198
|
+
|
|
199
|
+
> [!IMPORTANT]
|
|
200
|
+
> 読むだけの点検機能(PJR-9XEG)は現在準備中であるため、用意されたら移行前後の点検に利用します。現時点では本章の「確かめ方」と手順 1 の実行・worktree の点検を手動で行います。
|
|
201
|
+
|
|
202
|
+
### 4.3. 実行するコマンド
|
|
203
|
+
|
|
204
|
+
#### 4.3.1. 設定を配置する
|
|
205
|
+
|
|
206
|
+
新リポジトリのルートで `.specdojo/` を作成します。
|
|
207
|
+
|
|
208
|
+
```bash
|
|
209
|
+
mkdir -p .specdojo
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
元の `.specdojo/specdojo.config.json` の `projects.prj-0002` を、新しい `.specdojo/specdojo.config.json` に写し、`current_project` を `prj-0002` にします。以下は構成例です。実際には移行元の任意キーを含めて保持してください。
|
|
213
|
+
|
|
214
|
+
```json
|
|
215
|
+
{
|
|
216
|
+
"version": 1,
|
|
217
|
+
"current_project": "prj-0002",
|
|
218
|
+
"projects": {
|
|
219
|
+
"prj-0002": {
|
|
220
|
+
"base_path": "docs/ja/projects/prj-0002",
|
|
221
|
+
"catalog_path": "010-deliverables-catalog",
|
|
222
|
+
"schedule_path": "schedule",
|
|
223
|
+
"execution_path": "execution",
|
|
224
|
+
"members_path": "030-project-management/pm-members.yaml",
|
|
225
|
+
"roles_path": "030-project-management/pm-roles.yaml",
|
|
226
|
+
"viewpoints_path": "030-project-management/pm-review-viewpoints.yaml",
|
|
227
|
+
"project_register_path": "controls/project-register",
|
|
228
|
+
"routines_path": "routines",
|
|
229
|
+
"jobs_path": "jobs",
|
|
230
|
+
"project_context": ["prj-overview"],
|
|
231
|
+
"run": {
|
|
232
|
+
"register_date_timezone": "Asia/Tokyo",
|
|
233
|
+
"exec_defaults": ".specdojo/exec-defaults.yaml"
|
|
234
|
+
}
|
|
235
|
+
}
|
|
236
|
+
}
|
|
237
|
+
}
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
元リポジトリから、`agent_members_path`(既定 `.specdojo/agent-members.yaml`)、`run.exec_defaults` のファイル、Markdown の検査設定を写します。project 配下の人間の名簿は手順 1 に含まれます。agent の別名と owner の解決を確認し、`repos[].path`・`run.*` のリポジトリルート基準のパス、統合先ブランチ、provider のコマンド、親検証の npm scripts を新しい配置へ合わせます。元の設定をそのまま使って存在しない検査やパスを指さないようにしてください。
|
|
241
|
+
|
|
242
|
+
`node_modules/` と生成物を commit に含めないため、配置した設定を使って除外ルールを確認・補完します。
|
|
243
|
+
|
|
244
|
+
```bash
|
|
245
|
+
npx specdojo config init --dry-run
|
|
246
|
+
npx specdojo config init
|
|
247
|
+
git status --short
|
|
248
|
+
git add .specdojo package.json package-lock.json .gitignore
|
|
249
|
+
git commit -m "chore(prj-0002): configure specdojo settings and defaults"
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
検査設定や独自 Kata を移した場合は、それらも確認して個別に追加します。
|
|
253
|
+
|
|
254
|
+
#### 4.3.2. 点検後に元から外す
|
|
255
|
+
|
|
256
|
+
「4.4. 確かめ方」の新リポジトリ側の点検がすべて通ってから実施します。
|
|
257
|
+
|
|
258
|
+
元リポジトリ(`specdojo`)で:
|
|
259
|
+
|
|
260
|
+
- `.specdojo/specdojo.config.json` の `projects` から `prj-0002` の定義を削除します(もし `current_project` が `prj-0002` を指していれば残る project ID へ変更します)。
|
|
261
|
+
- 名簿や exec-defaults のうち、移行した project 専用で他に参照がない項目・ファイルを外します。他の project と共有する定義は残します。定期起動の設定も新しい管理先へ切り替えます。
|
|
262
|
+
- 元リポジトリの Git から `docs/ja/projects/prj-0002` を削除してコミットします。
|
|
263
|
+
|
|
264
|
+
```bash
|
|
265
|
+
cd ../specdojo
|
|
266
|
+
git rm -r docs/ja/projects/prj-0002
|
|
267
|
+
git add .specdojo
|
|
268
|
+
git diff --cached --stat
|
|
269
|
+
git commit -m "chore(prj-0002): remove project files moved to separate repository"
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
### 4.4. 確かめ方
|
|
273
|
+
|
|
274
|
+
- 新リポジトリで `npx specdojo project list` を実行し、`prj-0002` の配置が正しく認識されることを確認します。
|
|
275
|
+
- `npx specdojo register history --project prj-0002 --limit 10` で既存 event を読めることを確認します。登録簿の個票・event の件数と ID、実行記録を元のコピーと照合します。
|
|
276
|
+
- `npx specdojo register build --project prj-0002` と `npx specdojo dashboard build --project prj-0002` を実行し、一覧とダッシュボードが生成されることを確認します。これらは生成物を書き込む検証です。
|
|
277
|
+
- 元から外した後、元リポジトリで `npx specdojo project list` と `git status` を確認し、残る project が認識され、削除対象が意図どおりであることを確認します。
|
|
278
|
+
|
|
279
|
+
### 4.5. 戻し方
|
|
280
|
+
|
|
281
|
+
- 両側の起動を止め、元リポジトリの削除と設定変更を含むコミットを特定して `git revert <削除コミットのSHA>` で打ち消します。新しい起票や実行がある場合は先に差分を保全・照合し、二重運用を避けます。
|
|
282
|
+
|
|
283
|
+
## 5. 手順4: 相互起票のための `external_projects` 宣言
|
|
284
|
+
|
|
285
|
+
リポジトリを分離した後も、元リポジトリから新リポジトリへ、また新リポジトリから元リポジトリへ相互に起票できるよう、双方の `specdojo.config.json` に `external_projects` を宣言します。
|
|
286
|
+
|
|
287
|
+
### 5.1. 前提
|
|
288
|
+
|
|
289
|
+
- 双方のリポジトリの相対パスが決まっていること(例: 同一階層の `../specdojo-lp-specdojo` と `../specdojo`)。
|
|
290
|
+
- 相手のリポジトリに SpecDojo 0.4.2 以上が導入されていること。
|
|
291
|
+
|
|
292
|
+
### 5.2. 実行するコマンド
|
|
293
|
+
|
|
294
|
+
#### 5.2.1. 元から新しい管理先を宣言する
|
|
295
|
+
|
|
296
|
+
元リポジトリの `.specdojo/specdojo.config.json` のトップレベルへ次のキーを追加します。以下の JSON は既存の `projects` を保持して追加する部分だけを示します。
|
|
297
|
+
|
|
298
|
+
```json
|
|
299
|
+
{
|
|
300
|
+
"external_projects": {
|
|
301
|
+
"specdojo-lp": {
|
|
302
|
+
"path": "../specdojo-lp-specdojo",
|
|
303
|
+
"project_id": "prj-0002"
|
|
304
|
+
}
|
|
305
|
+
}
|
|
306
|
+
}
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
#### 5.2.2. 新しい管理先から元を宣言する
|
|
310
|
+
|
|
311
|
+
新リポジトリの `.specdojo/specdojo.config.json` のトップレベルへ追加します。
|
|
312
|
+
|
|
313
|
+
```json
|
|
314
|
+
{
|
|
315
|
+
"external_projects": {
|
|
316
|
+
"specdojo-core": {
|
|
317
|
+
"path": "../specdojo",
|
|
318
|
+
"project_id": "prj-0001"
|
|
319
|
+
}
|
|
320
|
+
}
|
|
321
|
+
}
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
### 5.3. 確かめ方
|
|
325
|
+
|
|
326
|
+
設定の変更を各リポジトリで確認・commit し、双方の作業ツリーがクリーンで、project の統合先ブランチが存在することを確認します。元リポジトリ側で、書き込みをしない起票確認を行います。外部起票には `--commit` が必須ですが、`--dry-run` を併用すると書き込み・commit を行いません。
|
|
327
|
+
|
|
328
|
+
```bash
|
|
329
|
+
npx specdojo register add --project specdojo-lp --type note --title "外部起票の接続テスト" --topic external-move-check --commit --dry-run
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
新リポジトリ側でも `--project specdojo-core` で同じ確認を行います。出力の project ID と個票の配置先が相手を指し、双方の `git status --short` が変わらないことを確認します。`--dry-run` を外すと相手側で commit されるため、試験チケットの追加・削除を点検手段にしません。相手が SpecDojo 本体の場合は npm 依存の CLI がなくても `dist/specdojo.js` から起動できるため、元で `npm run build` を済ませます。
|
|
333
|
+
|
|
334
|
+
### 5.4. 戻し方
|
|
335
|
+
|
|
336
|
+
- 双方の `.specdojo/specdojo.config.json` の `external_projects` から追加した別名だけを削除します。
|
|
337
|
+
|
|
338
|
+
## 6. 手順5: 元のリポジトリの文書サイトから外す
|
|
339
|
+
|
|
340
|
+
元リポジトリのドキュメントサイト(VitePress)から移行したプロジェクトを除外し、リンク切れやビルド失敗を防ぎます。
|
|
341
|
+
|
|
342
|
+
### 6.1. 前提
|
|
343
|
+
|
|
344
|
+
- 元リポジトリから `docs/ja/projects/prj-0002` の削除が完了していること。
|
|
345
|
+
|
|
346
|
+
### 6.2. 実行するコマンドと確認
|
|
347
|
+
|
|
348
|
+
#### 6.2.1. サイドバーを確認する
|
|
349
|
+
|
|
350
|
+
このリポジトリの文書サイトは `docs/ja/projects/` 配下からサイドバーを生成するため、ディレクトリ削除で表示対象から外れます。固定メニュー(`sidebar-config.ts` や `config.mts`)、トップページ、生成済みページにも参照があれば取り除きます。
|
|
351
|
+
|
|
352
|
+
#### 6.2.2. 双方向のリンクを点検する
|
|
353
|
+
|
|
354
|
+
元の文書から `prj-0002` への参照と、移した文書から元に残った文書への参照の両方を点検します。`external_projects` の宣言だけでは wikilink は解決されません。
|
|
355
|
+
|
|
356
|
+
> [!NOTE]
|
|
357
|
+
> リポジトリをまたぐリンクの標準的な書き方(PJR-66ER)は現在準備中であるため、用意されたらその記法に従います。現時点では `rg` で検索し、移行で解決不能になる wikilink を、相手の文書への実在する完全 URL に置き換えます。URL が未確定なら文書 ID をインラインコードで残して移行記録へ記載し、切替前に参照先を確認します。
|
|
358
|
+
|
|
359
|
+
```bash
|
|
360
|
+
# 元リポジトリで実行(終了コード 1 は一致なし)
|
|
361
|
+
rg -n 'prj-0002:|/projects/prj-0002/' docs packages/docs-site
|
|
362
|
+
# 新リポジトリで実行(元に prj-0001 が残る例)
|
|
363
|
+
rg -n 'prj-0001:|/projects/prj-0001/' docs
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
#### 6.2.3. 文書サイトを検証する
|
|
367
|
+
|
|
368
|
+
元リポジトリで実行し、リンク切れエラーなく成功することを確認します。
|
|
369
|
+
|
|
370
|
+
```bash
|
|
371
|
+
npm run docs:build
|
|
372
|
+
```
|
|
373
|
+
|
|
374
|
+
### 6.3. 確かめ方
|
|
375
|
+
|
|
376
|
+
- `npm run docs:dev` でローカルサーバーを起動し、ブラウザでサイドバーから `prj-0002` が除外されていることを確認します。
|
|
377
|
+
- `npm run docs:build` がエラー終了せず正常に完了することを確認します。
|
|
378
|
+
|
|
379
|
+
### 6.4. 戻し方
|
|
380
|
+
|
|
381
|
+
- サイドバー設定やリンクの変更を取り消し、必要に応じて元ファイルを復元します。
|