* 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:
243
gsd-core/workflows/extract-learnings.md
Normal file
243
gsd-core/workflows/extract-learnings.md
Normal file
@@ -0,0 +1,243 @@
|
||||
<purpose>
|
||||
Extract decisions, lessons learned, patterns discovered, and surprises encountered from completed phase artifacts into a structured LEARNINGS.md file. Captures institutional knowledge that would otherwise be lost between phases.
|
||||
</purpose>
|
||||
|
||||
<required_reading>
|
||||
Read all files referenced by the invoking prompt's execution_context before starting.
|
||||
</required_reading>
|
||||
|
||||
<objective>
|
||||
Analyze completed phase artifacts (PLAN.md, SUMMARY.md, VERIFICATION.md, UAT.md, STATE.md) and extract structured learnings into 4 categories: decisions, lessons, patterns, and surprises. Each extracted item includes source attribution. The output is a LEARNINGS.md file with YAML frontmatter containing metadata about the extraction.
|
||||
</objective>
|
||||
|
||||
<process>
|
||||
|
||||
<step name="initialize">
|
||||
Parse arguments and load project state:
|
||||
|
||||
```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
|
||||
INIT=$(gsd_run query init.phase-op "${PHASE_ARG}")
|
||||
if [[ "$INIT" == @file:* ]]; then INIT=$(cat "${INIT#@file:}"); fi
|
||||
```
|
||||
|
||||
Parse from init JSON: `phase_found`, `phase_dir`, `phase_number`, `phase_name`, `padded_phase`.
|
||||
|
||||
If phase not found, exit with error: "Phase {PHASE_ARG} not found."
|
||||
</step>
|
||||
|
||||
<step name="collect_artifacts">
|
||||
Read the phase artifacts. PLAN.md and SUMMARY.md are required; VERIFICATION.md, UAT.md, and STATE.md are optional.
|
||||
|
||||
**Required artifacts:**
|
||||
- `${PHASE_DIR}/*-PLAN.md` — all plan files for the phase
|
||||
- `${PHASE_DIR}/*-SUMMARY.md` — all summary files for the phase
|
||||
|
||||
If PLAN.md or SUMMARY.md files are not found or missing, exit with error: "Required artifacts missing. PLAN.md and SUMMARY.md are required for learning extraction."
|
||||
|
||||
**Optional artifacts (read if available, skip if not found):**
|
||||
- `${PHASE_DIR}/*-VERIFICATION.md` — verification results
|
||||
- `${PHASE_DIR}/*-UAT.md` — user acceptance test results
|
||||
- `.planning/STATE.md` — project state with decisions and blockers
|
||||
|
||||
Track which optional artifacts are missing for the `missing_artifacts` frontmatter field.
|
||||
</step>
|
||||
|
||||
<step name="extract-learnings">
|
||||
Analyze all collected artifacts and extract learnings into 4 categories:
|
||||
|
||||
### 1. Decisions
|
||||
Technical and architectural decisions made during the phase. Look for:
|
||||
- Explicit decisions documented in PLAN.md or SUMMARY.md
|
||||
- Technology choices and their rationale
|
||||
- Trade-offs that were evaluated
|
||||
- Design decisions recorded in STATE.md
|
||||
|
||||
Each decision entry must include:
|
||||
- **What** was decided
|
||||
- **Why** it was decided (rationale)
|
||||
- **Source:** attribution to the artifact where the decision was found (e.g., "Source: 03-01-PLAN.md")
|
||||
|
||||
### 2. Lessons
|
||||
Things learned during execution that were not known beforehand. Look for:
|
||||
- Unexpected complexity in SUMMARY.md
|
||||
- Issues discovered during verification in VERIFICATION.md
|
||||
- Failed approaches documented in SUMMARY.md
|
||||
- UAT feedback that revealed gaps
|
||||
|
||||
Each lesson entry must include:
|
||||
- **What** was learned
|
||||
- **Context** for the lesson
|
||||
- **Source:** attribution to the originating artifact
|
||||
|
||||
### 3. Patterns
|
||||
Reusable patterns, approaches, or techniques discovered. Look for:
|
||||
- Successful implementation patterns in SUMMARY.md
|
||||
- Testing patterns from VERIFICATION.md or UAT.md
|
||||
- Workflow patterns that worked well
|
||||
- Code organization patterns from PLAN.md
|
||||
|
||||
Each pattern entry must include:
|
||||
- **Pattern** name/description
|
||||
- **When to use** it
|
||||
- **Source:** attribution to the originating artifact
|
||||
|
||||
### 4. Surprises
|
||||
Unexpected findings, behaviors, or outcomes. Look for:
|
||||
- Things that took longer or shorter than estimated
|
||||
- Unexpected dependencies or interactions
|
||||
- Edge cases not anticipated in planning
|
||||
- Performance or behavior that differed from expectations
|
||||
|
||||
Each surprise entry must include:
|
||||
- **What** was surprising
|
||||
- **Impact** of the surprise
|
||||
- **Source:** attribution to the originating artifact
|
||||
</step>
|
||||
|
||||
<step name="capture_thought_integration">
|
||||
**What this step is:** `capture_thought` is an **optional convention**, not a bundled GSD tool. GSD does not ship one and does not require one. The step is a hook for users who run a memory / knowledge-base MCP server (for example ExoCortex-style servers, `claude-mem`, or `mem0`-style servers) that exposes a tool with this exact name. If any MCP server in the current session provides a `capture_thought` tool with the signature below, each extracted learning is routed through it with metadata. If no such tool is present, the step is a silent no-op — `LEARNINGS.md` is always the primary output.
|
||||
|
||||
**Detection:** Check whether a tool named `capture_thought` is available in the current session. Do not assume any specific MCP server is connected.
|
||||
|
||||
**If available**, call once per extracted learning:
|
||||
|
||||
```
|
||||
capture_thought({
|
||||
category: "decision" | "lesson" | "pattern" | "surprise",
|
||||
phase: PHASE_NUMBER,
|
||||
content: LEARNING_TEXT,
|
||||
source: ARTIFACT_NAME
|
||||
})
|
||||
```
|
||||
|
||||
**If not available** (no MCP server in the session exposes this tool, or the runtime does not support it), skip the step silently and continue. The workflow must not fail or warn — this is expected behavior for users who do not run a knowledge-base MCP.
|
||||
</step>
|
||||
|
||||
<step name="write_learnings">
|
||||
Write the LEARNINGS.md file to the phase directory. If a previous LEARNINGS.md exists, overwrite it (replace the file entirely).
|
||||
|
||||
Output path: `${PHASE_DIR}/${PADDED_PHASE}-LEARNINGS.md`
|
||||
|
||||
The file must have YAML frontmatter with these fields:
|
||||
```yaml
|
||||
---
|
||||
phase: {PHASE_NUMBER}
|
||||
phase_name: "{PHASE_NAME}"
|
||||
project: "{PROJECT_NAME}"
|
||||
generated: "{ISO_DATE}"
|
||||
counts:
|
||||
decisions: {N}
|
||||
lessons: {N}
|
||||
patterns: {N}
|
||||
surprises: {N}
|
||||
missing_artifacts:
|
||||
- "{ARTIFACT_NAME}"
|
||||
---
|
||||
```
|
||||
|
||||
Individual items may carry an optional `graduated:` annotation (added by `graduation.md` when a cluster is promoted):
|
||||
```markdown
|
||||
**Graduated:** {target-file}:{ISO_DATE}
|
||||
```
|
||||
This annotation is appended after the item's existing fields and prevents the item from being re-surfaced in future graduation scans. Do not add this field during extraction — it is written only by the graduation workflow.
|
||||
|
||||
The body follows this structure:
|
||||
```markdown
|
||||
# Phase {PHASE_NUMBER} Learnings: {PHASE_NAME}
|
||||
|
||||
## Decisions
|
||||
|
||||
### {Decision Title}
|
||||
{What was decided}
|
||||
|
||||
**Rationale:** {Why}
|
||||
**Source:** {artifact file}
|
||||
|
||||
---
|
||||
|
||||
## Lessons
|
||||
|
||||
### {Lesson Title}
|
||||
{What was learned}
|
||||
|
||||
**Context:** {context}
|
||||
**Source:** {artifact file}
|
||||
|
||||
---
|
||||
|
||||
## Patterns
|
||||
|
||||
### {Pattern Name}
|
||||
{Description}
|
||||
|
||||
**When to use:** {applicability}
|
||||
**Source:** {artifact file}
|
||||
|
||||
---
|
||||
|
||||
## Surprises
|
||||
|
||||
### {Surprise Title}
|
||||
{What was surprising}
|
||||
|
||||
**Impact:** {impact description}
|
||||
**Source:** {artifact file}
|
||||
```
|
||||
</step>
|
||||
|
||||
<step name="update_state">
|
||||
Update STATE.md to reflect the learning extraction:
|
||||
|
||||
```bash
|
||||
gsd_run query state.update "Last Activity" "$(date +%Y-%m-%d)"
|
||||
```
|
||||
</step>
|
||||
|
||||
<step name="report">
|
||||
```
|
||||
---------------------------------------------------------------
|
||||
|
||||
## Learnings Extracted: Phase {X} — {Name}
|
||||
|
||||
Decisions: {N}
|
||||
Lessons: {N}
|
||||
Patterns: {N}
|
||||
Surprises: {N}
|
||||
Total: {N}
|
||||
|
||||
Output: {PHASE_DIR}/{PADDED_PHASE}-LEARNINGS.md
|
||||
|
||||
Missing artifacts: {list or "none"}
|
||||
|
||||
Next steps:
|
||||
- Review extracted learnings for accuracy
|
||||
- /gsd:progress — see overall project state
|
||||
- /gsd:execute-phase {next} — continue to next phase
|
||||
|
||||
---------------------------------------------------------------
|
||||
```
|
||||
</step>
|
||||
|
||||
</process>
|
||||
|
||||
<success_criteria>
|
||||
- [ ] Phase artifacts located and read successfully
|
||||
- [ ] All 4 categories extracted: decisions, lessons, patterns, surprises
|
||||
- [ ] Each extracted item has source attribution
|
||||
- [ ] LEARNINGS.md written with correct YAML frontmatter
|
||||
- [ ] Missing optional artifacts tracked in frontmatter
|
||||
- [ ] capture_thought integration attempted if tool available
|
||||
- [ ] STATE.md updated with extraction activity
|
||||
- [ ] User receives summary report
|
||||
</success_criteria>
|
||||
|
||||
<critical_rules>
|
||||
- PLAN.md and SUMMARY.md are required — exit with clear error if missing
|
||||
- VERIFICATION.md, UAT.md, and STATE.md are optional — extract from them if present, skip gracefully if not found
|
||||
- Every extracted learning must have source attribution back to the originating artifact
|
||||
- Running extract-learnings twice on the same phase must overwrite (replace) the previous LEARNINGS.md, not append
|
||||
- Do not fabricate learnings — only extract what is explicitly documented in artifacts
|
||||
- If capture_thought is unavailable, the workflow must not fail — graceful degradation to file-only output
|
||||
- LEARNINGS.md frontmatter must include counts for all 4 categories and list any missing_artifacts
|
||||
</critical_rules>
|
||||
Reference in New Issue
Block a user