debeabd524
* feat(#3587): add a per-phase commit_docs override Delivers epic #2292's second user story: commit an architecture phase's artifacts while execution phases stay local. commit_docs was project-wide and binary, so the only choices were all phases or none. Shape is a config dynamic key phase_commit_docs.<phase-id>, following the 14 existing dynamicKeyPatterns precedents rather than inventing a PLAN.md frontmatter spec -- which #2292 itself flags as becoming its own maintenance surface. Tier 1 resolves in cmdCommit, NOT in loadConfig: loadConfig has no phase context and is called by nearly every command, so threading one through it to serve a single caller would be a far larger blast radius for no gain. The phase comes from detectPhaseNumberFromFiles, which cmdCommit already computes for branch naming and which is already hardened against the #2539 project-code bug. Suppression by the per-phase tier returns its own reason rather than reusing skipped_commit_docs_false -- telling a user their project setting is false when it is true would be actively misleading. Additive; the two existing reason strings that agents/gsd-executor.md matches on are unchanged. The manifest's phase-id pattern is a hand-copy of PHASE_NUMBER_TOKEN_SOURCE because the manifest is hand-maintained JSON, so a behavioral parity test asserts both surfaces accept and reject the same token shapes. * fix(#3587): fold tests, close review findings, update reference docs Fold: the new tests were added as their own file, which required loosening a grandfathered lint-test-file-count bucket 5-to-6. A ratchet exists to go down only. commit-docs-bypass.test.cjs is the established commit_docs test home and already hosts two folded suites, so the tests fold there as a third block and the allowlist is reverted untouched. Standards review: CONTEXT.md and the test header both cited a phase-commit-docs-manifest-parity.test.cjs that never existed; a repo-wide sweep found a fourth stale cite in the schema manifest description. All four now name the real location. Spec review: the issue's Scope of changes named planning-config.md and git-planning-commit.md and neither was touched. Both now document the four-tier precedence and the new skip reason. Security review, minor and unproven: detectPhaseNumberFromFiles returns the FIRST matching path's phase, so a --files list spanning two phases resolves the override against whichever comes first. That helper is hardened and widely used, so it is not changed; the behavior is pinned by a named test and disclosed in the design and user docs. A pinned behavior is not a bug; an unpinned surprise is. * chore(#3587): backfill changeset pr number to 3601 --------- Co-authored-by: sim <sim@local>
193 lines
6.9 KiB
JSON
193 lines
6.9 KiB
JSON
{
|
|
"_comment": "Canonical schema manifest for valid config key paths. This manifest is the single CJS source of truth for valid config keys; dynamicKeyPatterns source strings are recompiled to RegExp at runtime by config-schema.cjs. runtimeStateKeys mirrors RUNTIME_STATE_KEYS.",
|
|
"validKeys": [
|
|
"mode",
|
|
"granularity",
|
|
"parallelization",
|
|
"commit_docs",
|
|
"model_profile",
|
|
"search_gitignored",
|
|
"brave_search",
|
|
"firecrawl",
|
|
"exa_search",
|
|
"tavily_search",
|
|
"ref_search",
|
|
"perplexity",
|
|
"jina",
|
|
"workflow.plan_check",
|
|
"workflow.verifier",
|
|
"workflow.auto_advance",
|
|
"workflow.node_repair",
|
|
"workflow.node_repair_budget",
|
|
"workflow.smart_zone_tokens",
|
|
"workflow.human_verify_mode",
|
|
"workflow.text_mode",
|
|
"workflow.research_before_questions",
|
|
"workflow.discuss_mode",
|
|
"workflow.skip_discuss",
|
|
"workflow.auto_prune_state",
|
|
"workflow.use_worktrees",
|
|
"workflow.worktree_skip_hooks",
|
|
"workflow.code_review_command",
|
|
"workflow.plan_bounce",
|
|
"workflow.plan_bounce_script",
|
|
"workflow.plan_bounce_passes",
|
|
"workflow.plan_chunked",
|
|
"workflow.specless_probe_fallback",
|
|
"workflow.plan_review_convergence",
|
|
"workflow.agent_hint_routing",
|
|
"code_quality.fallow.enabled",
|
|
"code_quality.fallow.scope",
|
|
"code_quality.fallow.profile",
|
|
"code_quality.fallow.mcp",
|
|
"ship.pr_body_sections",
|
|
"git.branching_strategy",
|
|
"git.base_branch",
|
|
"git.create_tag",
|
|
"git.phase_branch_template",
|
|
"git.milestone_branch_template",
|
|
"git.quick_branch_template",
|
|
"planning.commit_docs",
|
|
"planning.search_gitignored",
|
|
"planning.sub_repos",
|
|
"review.default_reviewers",
|
|
"review.max_prompt_tokens",
|
|
"review.max_prompt_tokens_per_reviewer",
|
|
"workflow.cross_ai_execution",
|
|
"workflow.cross_ai_command",
|
|
"workflow.cross_ai_timeout",
|
|
"workflow.subagent_timeout",
|
|
"workflow.test_gate_timeout",
|
|
"workflow.test_command",
|
|
"workflow.build_command",
|
|
"workflow.mvp_mode",
|
|
"workflow.context_guard_mode",
|
|
"executor.stall_detect_interval_minutes",
|
|
"executor.stall_threshold_minutes",
|
|
"planner.stall_detect_interval_minutes",
|
|
"planner.stall_threshold_minutes",
|
|
"workflow.inline_plan_threshold",
|
|
"hooks.context_warnings",
|
|
"hooks.workflow_guard",
|
|
"workflow.context_coverage_gate",
|
|
"statusline.show_last_command",
|
|
"statusline.context_position",
|
|
"statusline.show_context_tokens",
|
|
"statusline.state_format",
|
|
"statusline.show_git",
|
|
"workflow.max_discuss_passes",
|
|
"features.thinking_partner",
|
|
"context",
|
|
"features.global_learnings",
|
|
"learnings.max_inject",
|
|
"project_code",
|
|
"phase_id_convention",
|
|
"phase_naming",
|
|
"manager.flags.discuss",
|
|
"manager.flags.plan",
|
|
"manager.flags.execute",
|
|
"response_language",
|
|
"context_window",
|
|
"graphify.build_timeout",
|
|
"graphify.auto_update",
|
|
"graphify.graph_path",
|
|
"claude_md_path",
|
|
"claude_md_assembly.mode",
|
|
"runtime",
|
|
"resolve_model_ids",
|
|
"effort.default",
|
|
"fast_mode.enabled",
|
|
"plan_review.source_grounding",
|
|
"plan_review.source_grounding_authority",
|
|
"model_policy.provider",
|
|
"model_policy.budget",
|
|
"model_policy.high",
|
|
"model_policy.medium",
|
|
"model_policy.low",
|
|
"agent_skills_security.trusted_global_roots",
|
|
"capabilities.strict_known_registries",
|
|
"capabilities.auto_update",
|
|
"security.injection_blocking"
|
|
],
|
|
"runtimeStateKeys": [
|
|
"workflow._auto_chain_active"
|
|
],
|
|
"dynamicKeyPatterns": [
|
|
{
|
|
"topLevel": "agent_skills",
|
|
"source": "^agent_skills\\.[a-zA-Z0-9_-]+$",
|
|
"description": "agent_skills.<agent-type>"
|
|
},
|
|
{
|
|
"topLevel": "features",
|
|
"source": "^features\\.[a-zA-Z0-9_]+$",
|
|
"description": "features.<feature_name>"
|
|
},
|
|
{
|
|
"topLevel": "claude_md_assembly",
|
|
"source": "^claude_md_assembly\\.blocks\\.[a-zA-Z0-9_]+$",
|
|
"description": "claude_md_assembly.blocks.<section>"
|
|
},
|
|
{
|
|
"topLevel": "model_profile_overrides",
|
|
"source": "^model_profile_overrides\\.[a-zA-Z0-9_-]+\\.(opus|sonnet|haiku)$",
|
|
"description": "model_profile_overrides.<runtime>.<opus|sonnet|haiku>"
|
|
},
|
|
{
|
|
"topLevel": "models",
|
|
"source": "^models\\.(planning|discuss|research|execution|verification|completion)$",
|
|
"description": "models.<planning|discuss|research|execution|verification|completion>"
|
|
},
|
|
{
|
|
"topLevel": "granularities",
|
|
"source": "^granularities\\.(planning|discuss|research|execution|verification|completion)$",
|
|
"description": "granularities.<planning|discuss|research|execution|verification|completion>"
|
|
},
|
|
{
|
|
"topLevel": "dynamic_routing",
|
|
"source": "^dynamic_routing\\.(enabled|escalate_on_failure|max_escalations|provider_escalation|tier_models\\.(light|standard|heavy))$",
|
|
"description": "dynamic_routing.<enabled|escalate_on_failure|max_escalations|provider_escalation|tier_models.<light|standard|heavy>>"
|
|
},
|
|
{
|
|
"topLevel": "model_overrides",
|
|
"source": "^model_overrides\\.[a-zA-Z0-9_-]+$",
|
|
"description": "model_overrides.<agent-id>"
|
|
},
|
|
{
|
|
"topLevel": "effort",
|
|
"source": "^effort\\.routing_tier_defaults\\.(light|standard|heavy)$",
|
|
"description": "effort.routing_tier_defaults.<light|standard|heavy>"
|
|
},
|
|
{
|
|
"topLevel": "effort",
|
|
"source": "^effort\\.agent_overrides\\.[a-zA-Z0-9_-]+$",
|
|
"description": "effort.agent_overrides.<agent-id>"
|
|
},
|
|
{
|
|
"topLevel": "fast_mode",
|
|
"source": "^fast_mode\\.routing_tier_defaults\\.(light|standard|heavy)$",
|
|
"description": "fast_mode.routing_tier_defaults.<light|standard|heavy>"
|
|
},
|
|
{
|
|
"topLevel": "fast_mode",
|
|
"source": "^fast_mode\\.agent_overrides\\.[a-zA-Z0-9_-]+$",
|
|
"description": "fast_mode.agent_overrides.<agent-id>"
|
|
},
|
|
{
|
|
"topLevel": "review",
|
|
"source": "^review\\.reviewer_instances\\.[a-zA-Z0-9_-]+\\.(cli|model|agent)$",
|
|
"description": "review.reviewer_instances.<instance-name>.<cli|model|agent> (#1517)"
|
|
},
|
|
{
|
|
"topLevel": "model_policy",
|
|
"source": "^model_policy\\.runtime_tiers\\.[a-zA-Z0-9_-]+\\.(opus|sonnet|haiku)$",
|
|
"description": "model_policy.runtime_tiers.<runtime>.<opus|sonnet|haiku> (#3587)"
|
|
},
|
|
{
|
|
"topLevel": "phase_commit_docs",
|
|
"source": "^phase_commit_docs\\.\\d+[A-Z]?(?:\\.\\d+)*$",
|
|
"description": "phase_commit_docs.<phase-id> — per-phase commit_docs override (#3587). The <phase-id> segment is a hand-copy of the canonical PHASE_NUMBER_TOKEN_SOURCE grammar owned by src/phase-id.cts (#2128); this manifest is hand-maintained JSON so it cannot import that constant. Pinned against drift by the behavioral parity test in tests/commit-docs-bypass.test.cjs (folded 'phase-commit-docs' block, describe block 'E', #3587) — do not hand-edit this pattern without updating that test."
|
|
}
|
|
]
|
|
}
|