* 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>
228 lines
8.6 KiB
Markdown
228 lines
8.6 KiB
Markdown
# Verification Overrides
|
|
|
|
Mechanism for intentionally accepting must-have failures when the deviation is known and acceptable. Prevents verification loops on items that will never pass as originally specified.
|
|
|
|
<override_format>
|
|
|
|
## Override Format
|
|
|
|
Overrides are declared in the VERIFICATION.md frontmatter under an `overrides:` key:
|
|
|
|
```yaml
|
|
---
|
|
phase: 03-authentication
|
|
verified: 2026-04-05T12:00:00Z
|
|
status: passed
|
|
score: 5/5
|
|
overrides_applied: 2
|
|
overrides:
|
|
- must_have: "OAuth2 PKCE flow implemented"
|
|
reason: "Using session-based auth instead — PKCE unnecessary for server-rendered app"
|
|
accepted_by: "dave"
|
|
accepted_at: "2026-04-04T15:30:00Z"
|
|
- must_have: "Rate limiting on login endpoint"
|
|
reason: "Deferred to Phase 5 (infrastructure) — tracked in ROADMAP.md"
|
|
accepted_by: "dave"
|
|
accepted_at: "2026-04-04T15:30:00Z"
|
|
---
|
|
```
|
|
|
|
### Required Fields
|
|
|
|
| Field | Type | Description |
|
|
|-------|------|-------------|
|
|
| `must_have` | string | The must-have truth, artifact description, or key link being overridden. Does not need to be an exact match — fuzzy matching applies. |
|
|
| `reason` | string | Why this deviation is acceptable. Must be specific — not just "not needed". |
|
|
| `accepted_by` | string | Who accepted the override (username or role). Required. |
|
|
| `accepted_at` | string | ISO timestamp of when the override was accepted. Required. |
|
|
|
|
</override_format>
|
|
|
|
## When to Use
|
|
|
|
Overrides apply when a phase intentionally deviated from the original plan during execution — for example, a requirement was descoped, an alternative approach was chosen, or a dependency changed.
|
|
|
|
Without overrides, the verifier reports these as FAIL even though the deviation was intentional. Overrides let the developer mark specific items as `PASSED (override)` with a documented reason.
|
|
|
|
Overrides are appropriate when:
|
|
- A requirement changed after planning but ROADMAP.md hasn't been updated yet
|
|
- An alternative implementation satisfies the intent but not the literal wording
|
|
- A must-have is deferred to a later phase with explicit tracking
|
|
- External constraints make the original must-have impossible or unnecessary
|
|
|
|
## When NOT to Use
|
|
|
|
Overrides are NOT appropriate when:
|
|
- The implementation is simply incomplete — fix it instead
|
|
- The must-have is unclear — clarify it instead
|
|
- The developer wants to skip verification — that undermines the process
|
|
- Multiple must-haves are failing for the same phase — if more than 2-3 items need overrides, revisit the plan instead of overriding in bulk
|
|
|
|
<matching_rules>
|
|
|
|
## Matching Rules
|
|
|
|
Override matching uses **fuzzy matching**, not exact string comparison. This accommodates minor wording differences between how must-haves are phrased in ROADMAP.md, PLAN.md frontmatter, and the override entry.
|
|
|
|
### Matching Algorithm
|
|
|
|
1. **Normalize both strings:** case-insensitive comparison — lowercase both strings, strip punctuation, collapse whitespace
|
|
2. **Token overlap:** split into words, compute intersection
|
|
3. **Match threshold:** 80% token overlap in EITHER direction (override tokens found in must-have, OR must-have tokens found in override)
|
|
4. **Key noun priority:** nouns and technical terms (file paths, component names, API endpoints) are weighted higher than common words
|
|
|
|
### Examples
|
|
|
|
| Must-Have | Override `must_have` | Match? | Reason |
|
|
|-----------|---------------------|--------|--------|
|
|
| "User can authenticate via OAuth2 PKCE" | "OAuth2 PKCE flow implemented" | Yes | Key terms `OAuth2` and `PKCE` overlap, 80% threshold met |
|
|
| "Rate limiting on /api/auth/login" | "Rate limiting on login endpoint" | Yes | `rate limiting` + `login` overlap |
|
|
| "Chat component renders messages" | "OAuth2 PKCE flow implemented" | No | No meaningful token overlap |
|
|
| "src/components/Chat.tsx provides message list" | "Chat.tsx message list rendering" | Yes | `Chat.tsx` + `message` + `list` overlap |
|
|
|
|
### Ambiguity Resolution
|
|
|
|
If an override matches multiple must-haves, apply it to the **most specific match** (highest token overlap percentage). If still ambiguous, apply to the first match and log a warning.
|
|
|
|
</matching_rules>
|
|
|
|
<verifier_behavior>
|
|
|
|
## Verifier Behavior with Overrides
|
|
|
|
### Check Order
|
|
|
|
The override check happens **before marking a must-have as FAIL**. The flow is:
|
|
|
|
1. Evaluate must-have against codebase (Steps 3-5 of verification process)
|
|
2. If evaluation result is FAIL or UNCERTAIN:
|
|
a. Check `overrides:` array in VERIFICATION.md frontmatter for a fuzzy match
|
|
b. If override found: mark as `PASSED (override)` instead of FAIL
|
|
c. If no override found: mark as FAIL as normal
|
|
3. If evaluation result is PASS: mark as VERIFIED (overrides are irrelevant)
|
|
|
|
### Output Format
|
|
|
|
Overridden items appear with distinct status in all verification tables:
|
|
|
|
```markdown
|
|
| # | Truth | Status | Evidence |
|
|
|---|-------|--------|----------|
|
|
| 1 | User can authenticate | VERIFIED | OAuth session flow working |
|
|
| 2 | OAuth2 PKCE flow | PASSED (override) | Override: Using session-based auth — accepted by dave on 2026-04-04 |
|
|
| 3 | Chat renders messages | FAILED | Component returns placeholder |
|
|
```
|
|
|
|
The `PASSED (override)` status must be visually distinct from both `VERIFIED` and `FAILED`. In the evidence column, include the override reason and who accepted it.
|
|
|
|
### Impact on Overall Status
|
|
|
|
- `PASSED (override)` items count toward the passing score, not the failing score
|
|
- A phase with all items either VERIFIED or PASSED (override) can have status `passed`
|
|
- Overrides do NOT suppress `human_needed` items — those still require human testing
|
|
|
|
### Frontmatter Score
|
|
|
|
The score and override count in frontmatter reflect applied overrides:
|
|
|
|
```yaml
|
|
score: 5/5 # includes 2 overrides
|
|
overrides_applied: 2
|
|
```
|
|
|
|
</verifier_behavior>
|
|
|
|
<creating_overrides>
|
|
|
|
## Creating Overrides
|
|
|
|
### Interactive Override Suggestion
|
|
|
|
When the verifier marks a must-have as FAIL and the failure looks intentional (e.g., alternative implementation exists, or the code explicitly handles the case differently), the verifier should suggest creating an override:
|
|
|
|
```markdown
|
|
### F-002: OAuth2 PKCE flow
|
|
|
|
**Status:** FAILED
|
|
**Evidence:** No PKCE implementation found. Session-based auth used instead.
|
|
|
|
**This looks intentional.** The codebase uses session-based authentication which achieves the same goal differently. To accept this deviation, add an override to VERIFICATION.md frontmatter:
|
|
|
|
```yaml
|
|
overrides:
|
|
- must_have: "OAuth2 PKCE flow implemented"
|
|
reason: "Using session-based auth instead — PKCE unnecessary for server-rendered app"
|
|
accepted_by: "{your name}"
|
|
accepted_at: "{current ISO timestamp}"
|
|
```
|
|
|
|
Then re-run verification to apply.
|
|
```
|
|
|
|
### Override via gsd-tools
|
|
|
|
Overrides can also be managed through the verification workflow:
|
|
|
|
1. Run `/gsd:verify-work` — verification finds gaps
|
|
2. Review gaps — determine which are intentional deviations
|
|
3. Add override entries to VERIFICATION.md frontmatter
|
|
4. Re-run `/gsd:verify-work` — overrides are applied, remaining gaps shown
|
|
|
|
</creating_overrides>
|
|
|
|
<override_lifecycle>
|
|
|
|
## Override Lifecycle
|
|
|
|
### During Re-verification
|
|
|
|
When a phase is re-verified (e.g., after gap closure):
|
|
- Existing overrides carry forward automatically
|
|
- If the underlying code now satisfies the must-have, the override becomes unnecessary — mark as VERIFIED instead
|
|
- Overrides are never removed automatically; they persist as documentation
|
|
|
|
### At Milestone Completion
|
|
|
|
During `/gsd:audit-milestone`, overrides are surfaced in the audit report:
|
|
|
|
```
|
|
### Verification Overrides ({count} across {phase_count} phases)
|
|
|
|
| Phase | Must-Have | Reason | Accepted By |
|
|
|-------|----------|--------|-------------|
|
|
| 03 | OAuth2 PKCE | Session-based auth used instead | dave |
|
|
```
|
|
|
|
This gives the team visibility into all accepted deviations before closing the milestone.
|
|
|
|
### Cleanup
|
|
|
|
Stale overrides (where the must-have was later implemented or removed from ROADMAP.md) can be cleaned up during milestone completion. They are informational — leaving them causes no harm.
|
|
|
|
</override_lifecycle>
|
|
|
|
## Example VERIFICATION.md
|
|
|
|
```markdown
|
|
---
|
|
phase: 03-api-layer
|
|
verified: 2026-04-05T12:00:00Z
|
|
status: passed
|
|
score: 3/3
|
|
overrides_applied: 1
|
|
overrides:
|
|
- must_have: "paginated API responses"
|
|
reason: "Descoped — dataset under 100 items, pagination adds complexity without value"
|
|
accepted_by: "dave"
|
|
accepted_at: "2026-04-04T15:30:00Z"
|
|
---
|
|
|
|
## Phase 3: API Layer — Verification
|
|
|
|
| # | Truth | Status | Evidence |
|
|
|---|-------|--------|----------|
|
|
| 1 | REST endpoints return JSON | VERIFIED | curl tests confirm |
|
|
| 2 | Paginated API responses | PASSED (override) | Descoped — see override: dataset under 100 items |
|
|
| 3 | Authentication middleware | VERIFIED | JWT validation working |
|
|
```
|