463cffd894
* chore(#604): rename get-shit-done/ runtime directory to gsd-core/ Renames the installed runtime directory `get-shit-done/` to `gsd-core/` so the on-disk name matches the package (`@opengsd/gsd-core`), repo, and binary (`gsd-tools`). The npm package name and binary are unchanged; npx/npm consumers are unaffected. Mechanical (bulk, ~90% of the diff): - `git mv get-shit-done gsd-core` - Swept path/identifier references across the repo via `perl -pe 's/get-shit-done(?!-\w)/gsd-core/g'`. The negative lookahead preserves the five legitimate slug variants that are NOT the directory: get-shit-done-{OLD,cc,classic,cli,redux} (old package/repo names). - Build/manifest wiring: package.json (bin, files, coverage globs), tsconfig.build.json (outDir), ~86 .gitignore build-output entries, stryker.config.mjs, scan-ignore files, install.js path strings. - Frozen (not rewritten): CHANGELOG.md history; translated docs (README.<locale>.md and docs/{ja-JP,ko-KR,pt-BR,zh-CN}/). New logic (review here): - src/installer-migrations/003-rename-get-shit-done-to-gsd-core.cts: a proper ADR-0008 installer migration. On upgrade it walks the legacy `~/.claude/get-shit-done/` tree, classifies each file via the prior install manifest, and emits remove-managed / backup-and-remove for managed files while PRESERVING unknown user-added files. Symlink-safe (skips a symlinked root and symlinked entries; bounds-checks every path under configDir). The framework rolls back on install failure. Emptied dirs may remain (framework has no recursive dir-removal primitive) — documented. - scripts/lint-legacy-dir-name.cjs: CI regression guard forbidding the bare `get-shit-done` directory token (split token to avoid self-match; case- insensitive; `(?!-\w)` lookahead allows the slug variants; allowlists CHANGELOG, translated docs, and `gsd-allow-legacy-name` marker lines). Wired into the lint-tests CI job. - Restored scripts/lint-package-identity-drift.cjs detection regexes (the mechanical sweep had wrongly rewritten the old-name patterns it exists to detect) and marked them as intentional legacy references. - TDD tests for the migration and the guard; do.md slash-command guard regex tightened so a `/gsd-core/bin` path segment is not mistaken for a command; changeset + docs/installer-migrations.md row added. Breaking: the installed runtime path moves `~/.claude/get-shit-done/` -> `~/.claude/gsd-core/`. Migration 003 removes the stale legacy dir's managed files (preserving user files) on upgrade. Users with custom hooks/configs hardcoding the old path must update them. Closes #604 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): unsweep pending changesets + allowlist injection-example docs CI fixes for the rename PR: - Do not sweep pending .changeset/*.md (ephemeral release-note fragments, like CHANGELOG); reverted those body edits so 5 pre-existing malformed fragments (missing type/pr) no longer enter the PR diff and trip docs-lint. Allowlisted .changeset/ in the legacy-name guard accordingly. - Allowlisted TEST-EXAMPLES.md and docs/explanation/security-model.md in prompt-injection-scan.sh: they contain intentional injection examples / security-model prose; the path-reference rewrites are kept. CodeQL alerts on this PR are pre-existing (alert lines unchanged by this PR; none in the new migration/guard) and are out of scope for the rename. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): resolve CodeQL alerts surfaced on this PR The rename diff touched files carrying pre-existing CodeQL findings; per the no-pre-existing-dismissal rule, fixing every surfaced alert rather than waving them off. All behavior-preserving: - scripts/ci-test-scope.cjs: build the config-path match from string .includes() instead of a RegExp over an arg-derived value (js/regex-injection). - src/profile-output.cts: escape backslashes before pipe-escaping desc/safeName so the table-cell escape is complete (js/incomplete-sanitization). - tests/{bug-2643,bug-2808,docs-parity-live-registry}: two-pass HTML-comment strip so a bare/unclosed `<!--` cannot survive (js/incomplete-multi-character-sanitization). - tests/inline-plan-threshold: drop the no-op `\s`->`\s` identity replace, keep the meaningful POSIX-class conversion (js/identity-replacement). Verified: build:lib green; the touched test files + ci-test-scope + profile-output suites pass; lint:legacy-name clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): correctly resolve remaining CodeQL alerts (regex-injection + sanitization) The prior commit's fixes for two alerts were ineffective: - ci-test-scope.cjs js/regex-injection: the alert is the CLI-arg-derived `file` reaching static regex `.test(file)` calls (not the config rule). Removed ALL regex over file/t — startsWith/includes/=== string checks + an isWindowsHint helper — so there is no regex sink for the tainted value. - js/incomplete-multi-character-sanitization (3 test files): a single `.replace(/<!--...-->/g,'')` can let `<!--` re-form. Replaced with a fixpoint loop (replace until stable) plus a final bare-opener strip. Verified: no regex over file/t remains; ci-test-scope + the 3 test suites pass; lint:legacy-name clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): make ci-test-scope + comment-strippers regex-free to clear CodeQL CodeQL flags the regex PATTERNS syntactically (regex-injection on the --files arg split; incomplete-multi-character-sanitization on the <!--...--> replace), so loop fixes do not satisfy it. Made these paths regex-free: - ci-test-scope.cjs splitFiles: char-by-char separator tokenizer (no /[,\\s]+/). - 3 test files: indexOf/slice HTML-comment stripper (no .replace(/<!--/)). Behavior preserved; ci-test-scope + the 3 suites pass; guard clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): unblock security base64 scan on the large rename diff The security job hit its 10m timeout: base64-scan.sh choked on the binary test fixture tests/feat-3594-parser-property-style.test.cjs (embedded NUL/ non-UTF8 bytes -> thousands of bogus blobs + "ignored null byte" warnings), and the ~800-file rename diff is slow to scan regardless. - scripts/base64-scan.sh: skip binary-by-content files (grep -Iq .) — they can't carry base64-obfuscated *text* and feeding NUL bytes through the per-line scanner is pathologically slow. collect_files already filtered binary *extensions*; this catches binary *content* in text extensions. - .github/workflows/security-scan.yml: raise the security job timeout 10m->30m to accommodate very large diffs (the scan itself is unchanged). Verified locally: scan skips the fixture, 0 "ignored null byte" warnings, 0 findings, exit 0. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): sweep get-shit-done refs introduced by merging next The branch was updated with next (#614/#384/#618 etc.), which reference the get-shit-done/ dir (still named that on next). Swept the stale references in the merged files to gsd-core so the rename stays consistent and lint:legacy-name passes: - commands/gsd/discuss-phase.md (runtime-launcher shim paths) - src/core.cts (getAgentsDir layout comments) - tests/bug-384-agents-runtime-aware.test.cjs (require path to runtime lib) Verified: guard 0 violations; build green. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): exclude gsd-core/ path segments from bug-3683 command cross-ref invariant The #614 runtime-launcher shim added to discuss-phase.md references `${_GSD_RUNTIME_ROOT}/gsd-core/bin/...`. bug-3683's REF_PATTERN excluded path-y refs only via lookbehind, but `}` precedes `/gsd-core/` in the shim, so it mis-read the directory path as a dangling `/gsd-core` command ref (same class as the #604 bug-2954 fix). Added a trailing `(?![\w-]*\/)` so `/gsd-<x>/...` path segments are not treated as slash-command references. Verified locally on BOTH platforms before pushing: - mac (node 26) full suite: 0 failures - gsd-test-runner (linux, node22 image) full suite: 0 failures - bug-3683 + bug-2954 pass. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): lazily resolve findProjectRoot in gsd-tools (harden flaky CI) CI intermittently failed state.test's gsd-tools subprocess with "findProjectRoot is not a function" (flip-flopping across legs; not reproducible on mac full suite, gsd-test linux full suite, test:unit, or state.test x8). findProjectRoot is a re-export from core.cjs (sourced from project-root.cjs); binding it via destructure at module-load can be undefined under a load-ordering edge. Resolve it lazily at call time via a small wrapper so the lookup happens after core.cjs is fully initialized. Verified green on BOTH platforms before pushing: - mac (node 26) full suite: 0 failures - gsd-test-runner (linux, node22) full suite: 0 failures - state.test.cjs: 106/106; gsd-tools loads cleanly. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): allowlist verification-patterns.md placeholder examples in secret scan The rename git-mv'd references/verification-patterns.md into gsd-core/, pulling it into the secret-scan diff. It documents stub/placeholder RED-FLAG env-var examples (illustrative Stripe test-key / database-URL / API-key placeholders) — not real credentials. Added it to .secretscanignore with the strict annotation, mirroring the existing gsd-core/workflows/plan-phase.md exception. Verified locally: secret-scan-lint --strict OK; secret-scan --diff origin/next exits 0 with 0 findings. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
105 lines
5.0 KiB
Markdown
105 lines
5.0 KiB
Markdown
# Render agent definitions from templates at install/config-change time
|
||
|
||
**Source:** [#2758](https://github.com/open-gsd/gsd-core/issues/2758)
|
||
**Decision:** wontfix — closed on the technical merits
|
||
**Date:** 2026-05-02
|
||
|
||
## Proposal summary
|
||
|
||
Move config-gated prose out of `agents/*.md` into `agents/templates/*.md.tmpl`,
|
||
rendered at install time and after `.planning/config.json` writes via a new
|
||
`gsd-sdk agents render` subcommand. Conditional branches resolve at render time
|
||
(deterministic code) instead of at inference time (LLM interpretation).
|
||
|
||
Three named benefits:
|
||
|
||
1. Token reduction proportional to disabled features.
|
||
2. Deterministic feature gating (impossible-by-construction vs. test-for).
|
||
3. Single source of truth for contributor-facing gating.
|
||
|
||
Cites PR #2279 (Codex/OpenCode model embedding at install time) as direct
|
||
precedent for compile-time embedding.
|
||
|
||
## Why GSD does not own this
|
||
|
||
### 1. The determinism claim is theoretical, not observed
|
||
|
||
The proposal's strongest argument is that config-gated branches in agent prose
|
||
are a determinism failure surface. The actual patterns in the codebase today are
|
||
already heavily mitigated:
|
||
|
||
- The `use_worktrees` branch in `gsd-executor` is resolved deterministically via
|
||
`gsd-sdk query config-get` in bash — it is not LLM-interpreted.
|
||
- "Skip if `workflow.X` is `false`" prose patterns are short, stable, and
|
||
follow a uniform "missing key = enabled" convention. There is no documented
|
||
history of LLMs running disabled checks or skipping enabled ones because of
|
||
this prose.
|
||
|
||
A theoretical failure surface should not be traded for a real, high-risk
|
||
patch-migration surface (`gsd-local-patches/` rebase logic, by the reporter's own
|
||
admission "the highest-risk piece of the change"). The reporter was asked for
|
||
documented evidence; none was provided.
|
||
|
||
### 2. Token waste is small and bounded
|
||
|
||
The codebase has roughly 5 `workflow.*` toggle references in agent files and
|
||
~20 "Skip if" conditional-prose patterns total — most 1–2 sentences. The
|
||
"real spend across multi-phase milestones" claim was not measured against
|
||
`gsd-context-monitor` output despite being asked. Without a measured baseline,
|
||
the token-savings argument is asserted rather than demonstrated, and the savings
|
||
ceiling on ~20 short conditionals is small enough that it does not justify a new
|
||
template-and-rendering subsystem with a CI-enforced template/generated split.
|
||
|
||
### 3. The deterministic-gating need is already served
|
||
|
||
PR #2279 established orchestrator-time config embedding for the cases that
|
||
genuinely need deterministic resolution (model selection, reasoning effort,
|
||
worktree mode). That mechanism is the right layer for orchestration-time
|
||
decisions and can be extended toggle-by-toggle along the existing path without
|
||
introducing a parallel templating subsystem. The proposal's own "Alternative #1"
|
||
(continue the orchestrator-embedding pattern) was rejected on the grounds that
|
||
agent-internal conditionals belong in the agent layer, but the asks behind the
|
||
proposal — determinism, lower token cost — are equally satisfied by extending
|
||
PR #2279 incrementally without a second mechanism.
|
||
|
||
Adding a templating layer alongside orchestrator-embedding means two mechanisms
|
||
own the same problem. The proposal does not specify a partition rule, and the
|
||
reporter did not respond when asked for one.
|
||
|
||
### 4. Patch-migration risk is disproportionate to benefit
|
||
|
||
The `/gsd-reapply-patches` three-way-merge migration for `gsd-local-patches/`
|
||
is, in the proposal's own words, the highest-risk piece of the change. It exists
|
||
solely to absorb a contributor-workflow shift — the user-facing surface is
|
||
unchanged. Risk that flows entirely from internal restructuring, where the
|
||
benefit is unmeasured token savings and a theoretical determinism gain, is the
|
||
wrong trade.
|
||
|
||
The reduced-scope variant (Alternative #5: fresh installs only, defer the
|
||
migration) avoids that specific risk but still ships a parallel mechanism for
|
||
benefits that remain unmeasured and that PR #2279's path can absorb.
|
||
|
||
## Re-open criteria
|
||
|
||
This may be revisited if a contributor:
|
||
|
||
- Provides measured token deltas via `gsd-context-monitor` against a
|
||
representative all-toggles-off config, and the delta is materially larger
|
||
than what extending PR #2279's orchestrator-embedding path one toggle at a
|
||
time would produce.
|
||
- Documents a real LLM misinterpretation of an existing toggle conditional
|
||
(executor ignored `workflow.use_worktrees: false`, verifier ran when
|
||
`workflow.verifier: false`, etc.) — not a projected failure mode.
|
||
- Proposes a clear partition rule between orchestrator-time embedding (PR #2279)
|
||
and any new install-time templating layer, so the two mechanisms do not
|
||
overlap.
|
||
|
||
## Related
|
||
|
||
- PR #2279 — Codex/OpenCode model embedding at install time (the established
|
||
precedent for deterministic compile-time embedding into agent files)
|
||
- v1.37.0 release notes — shared-boilerplate extraction (reference files for
|
||
mandatory-initial-read, project-skills-discovery)
|
||
- `gsd-core/workflows/` — workflow-level config embedding before subagent
|
||
spawn (the path of least friction for incremental deterministic gating)
|