* 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>
This commit is contained in:
196
gsd-core/workflows/graduation.md
Normal file
196
gsd-core/workflows/graduation.md
Normal file
@@ -0,0 +1,196 @@
|
||||
# graduation.md — LEARNINGS.md Cross-Phase Graduation Helper
|
||||
|
||||
**Invoked by:** `transition.md` step `graduation_scan`. Never invoked directly by users.
|
||||
|
||||
This workflow clusters recurring items across the last N phases' LEARNINGS.md files and surfaces promotion candidates to the developer via HITL. No item is promoted without explicit developer approval.
|
||||
|
||||
---
|
||||
|
||||
## Configuration
|
||||
|
||||
Read from project config (`config.json`):
|
||||
|
||||
| Key | Default | Description |
|
||||
|-----|---------|-------------|
|
||||
| `features.graduation` | `true` | Master on/off switch. `false` skips silently. |
|
||||
| `features.graduation_window` | `5` | How many prior phases to scan |
|
||||
| `features.graduation_threshold` | `3` | Minimum cluster size to surface |
|
||||
|
||||
---
|
||||
|
||||
## Step 1: Guard Checks
|
||||
|
||||
```bash
|
||||
_GSD_SHIM_NAME="gsd-tools.cjs"; _GSD_RUNTIME_ROOT="${RUNTIME_DIR:-$(git rev-parse --show-toplevel 2>/dev/null || pwd)}"; GSD_TOOLS="${_GSD_RUNTIME_ROOT}/gsd-core/bin/${_GSD_SHIM_NAME}"; if [ -f "$GSD_TOOLS" ]; then gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${_GSD_RUNTIME_ROOT}/.claude/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${_GSD_RUNTIME_ROOT}/.claude/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif command -v gsd-tools >/dev/null 2>&1; then GSD_TOOLS="$(command -v gsd-tools)"; gsd_run() { "$GSD_TOOLS" "$@"; }; elif [ -f "$HOME/.claude/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="$HOME/.claude/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; else echo "ERROR: gsd-tools.cjs not found at $GSD_TOOLS and gsd-tools is not on PATH. Run: npx -y @opengsd/gsd-core@latest --claude --local" >&2; exit 1; fi
|
||||
GRADUATION_ENABLED=$(gsd_run query config-get features.graduation 2>/dev/null || echo "true")
|
||||
GRADUATION_WINDOW=$(gsd_run query config-get features.graduation_window 2>/dev/null || echo "5")
|
||||
GRADUATION_THRESHOLD=$(gsd_run query config-get features.graduation_threshold 2>/dev/null || echo "3")
|
||||
```
|
||||
|
||||
**Skip silently (print nothing) if:**
|
||||
- `features.graduation` is `false`
|
||||
- Fewer than `graduation_threshold` completed prior phases exist (not enough data)
|
||||
|
||||
**Skip silently (print nothing) if total items across all LEARNINGS.md files in the window is fewer than 5.**
|
||||
|
||||
---
|
||||
|
||||
## Step 2: Collect LEARNINGS.md Files
|
||||
|
||||
Find LEARNINGS.md files from the last N completed phases (excluding the phase currently completing):
|
||||
|
||||
```bash
|
||||
find .planning/phases -name "*-LEARNINGS.md" | sort | tail -n "$GRADUATION_WINDOW"
|
||||
```
|
||||
|
||||
For each file found:
|
||||
1. Parse the four category sections: `## Decisions`, `## Lessons`, `## Patterns`, `## Surprises`
|
||||
2. Extract each `### Item Title` + body as a single item record: `{ category, title, body, source_phase, source_file }`
|
||||
3. **Skip items that already contain `**Graduated:**`** — they have been promoted and must not re-surface
|
||||
|
||||
---
|
||||
|
||||
## Step 3: Cluster by Lexical Similarity
|
||||
|
||||
For each category independently, cluster items using Jaccard similarity on tokenized title+body:
|
||||
|
||||
**Tokenization:** lowercase, strip punctuation, split on whitespace, remove stop words (a, an, the, is, was, in, on, at, to, for, of, and, or, but, with, from, that, this, by, as).
|
||||
|
||||
**Jaccard similarity:** `|A ∩ B| / |A ∪ B|` where A and B are token sets. Two items are in the same cluster if similarity ≥ 0.25.
|
||||
|
||||
**Clustering algorithm:** single-pass greedy — process items in phase order; add to the first cluster whose centroid (union of all cluster tokens) has similarity ≥ 0.25 with the new item; otherwise start a new cluster.
|
||||
|
||||
**Cluster size filter:** only surface clusters with distinct source phases ≥ `graduation_threshold` (not just total items — same item repeated in one phase still counts as 1 distinct phase).
|
||||
|
||||
---
|
||||
|
||||
## Step 4: Check graduation_backlog in STATE.md
|
||||
|
||||
Read `.planning/STATE.md` `graduation_backlog` section (if present). Format:
|
||||
|
||||
```yaml
|
||||
graduation_backlog:
|
||||
- cluster_id: "{sha256-of-cluster-title}"
|
||||
status: "dismissed" # or "deferred"
|
||||
deferred_until: "phase-N" # only for deferred entries
|
||||
cluster_title: "{representative title}"
|
||||
```
|
||||
|
||||
**Skip any cluster whose `cluster_id` matches a `dismissed` entry.**
|
||||
|
||||
**Skip any cluster whose `cluster_id` matches a `deferred` entry where `deferred_until` phase has not yet completed.**
|
||||
|
||||
---
|
||||
|
||||
## Step 5: Surface Promotion Candidates
|
||||
|
||||
For each qualifying cluster, determine the suggested target file:
|
||||
|
||||
| Category | Suggested Target |
|
||||
|----------|-----------------|
|
||||
| `decisions` | `PROJECT.md` — append under `## Validated Decisions` (create section if absent) |
|
||||
| `patterns` | `PATTERNS.md` — append under the appropriate category section (create file if absent) |
|
||||
| `lessons` | `PROJECT.md` — append under `## Invariants` (create section if absent) |
|
||||
| `surprises` | Flag for human review — if genuinely surprising 3+ times, something structural is wrong |
|
||||
|
||||
Print the graduation report:
|
||||
|
||||
```text
|
||||
📚 Graduation scan across phases {M}–{N}:
|
||||
|
||||
HIGH RECURRENCE ({K}/{WINDOW} phases)
|
||||
├─ Cluster: "{representative title}"
|
||||
├─ Category: {category}
|
||||
├─ Sources: {list of NN-LEARNINGS filenames}
|
||||
└─ Suggested target: {target file} § {section}
|
||||
|
||||
[repeat for each qualifying cluster, ordered HIGH→LOW recurrence]
|
||||
|
||||
For each cluster above, choose an action:
|
||||
P = Promote now D = Defer (re-surface next transition) X = Dismiss (never re-surface) A = Defer all remaining
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 6: HITL — Process Each Cluster
|
||||
|
||||
For each cluster (in order from Step 5), ask the developer:
|
||||
|
||||
```text
|
||||
Cluster: "{title}" [{category}, {K} phases] → {target}
|
||||
Action [P/D/X/A]:
|
||||
```
|
||||
|
||||
Use `AskUserQuestion` (or equivalent HITL primitive for the current runtime). If `TEXT_MODE` is true, display the cluster question as plain text and accept typed input. Accept single-character input: `P`, `D`, `X`, `A` (case-insensitive).
|
||||
|
||||
**On `P` (Promote now):**
|
||||
|
||||
1. Read the target file (or create it with a standard header if absent)
|
||||
2. Append the cluster entry under the suggested section:
|
||||
```markdown
|
||||
### {Cluster representative title}
|
||||
{Merged body — combine unique sentences across cluster items}
|
||||
|
||||
**Sources:** Phase {A}, Phase {B}, Phase {C}
|
||||
**Promoted:** {ISO_DATE}
|
||||
```
|
||||
3. For each source LEARNINGS.md item in the cluster, append `**Graduated:** {target-file}:{ISO_DATE}` after its last existing field
|
||||
4. Commit both the target file and all annotated LEARNINGS.md files in a single atomic commit:
|
||||
`docs(learnings): graduate "{cluster title}" to {target-file}`
|
||||
|
||||
**On `D` (Defer):**
|
||||
|
||||
Write to `.planning/STATE.md` under `graduation_backlog`:
|
||||
```yaml
|
||||
- cluster_id: "{sha256}"
|
||||
status: "deferred"
|
||||
deferred_until: "phase-{NEXT_PHASE_NUMBER}"
|
||||
cluster_title: "{title}"
|
||||
```
|
||||
|
||||
**On `X` (Dismiss):**
|
||||
|
||||
Write to `.planning/STATE.md` under `graduation_backlog`:
|
||||
```yaml
|
||||
- cluster_id: "{sha256}"
|
||||
status: "dismissed"
|
||||
cluster_title: "{title}"
|
||||
```
|
||||
|
||||
**On `A` (Defer all):**
|
||||
|
||||
Defer the current cluster (same as `D`) and skip all remaining clusters for this run, deferring each to the next transition. Print:
|
||||
```text
|
||||
[graduation: deferred all remaining clusters to next transition]
|
||||
```
|
||||
Then proceed directly to Step 7.
|
||||
|
||||
---
|
||||
|
||||
## Step 7: Completion Report
|
||||
|
||||
After processing all clusters, print:
|
||||
|
||||
```text
|
||||
Graduation complete: {promoted} promoted, {deferred} deferred, {dismissed} dismissed.
|
||||
```
|
||||
|
||||
If no clusters qualified (all filtered by backlog or threshold), print:
|
||||
```text
|
||||
[graduation: no qualifying clusters in phases {M}–{N}]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## First-Run Behaviour
|
||||
|
||||
On the first transition after upgrading to a version that includes this workflow, all extant LEARNINGS.md files may produce a large batch of candidates at once. A `[Defer all]` shorthand is available: if the developer enters `A` at any cluster prompt, all remaining clusters for this run are deferred to the next transition.
|
||||
|
||||
---
|
||||
|
||||
## No-Op Conditions (silent skip)
|
||||
|
||||
- `features.graduation = false`
|
||||
- Fewer than `graduation_threshold` prior phases with LEARNINGS.md
|
||||
- Total items < 5 across the window
|
||||
- All qualifying clusters are in `graduation_backlog` as dismissed
|
||||
Reference in New Issue
Block a user