fix: encode antigravity undocumented intent to break DDUw false-positive loop#47876
Conversation
Resolves the recurring antigravity engine documentation drift loop (#47875, escalating #46688) by making the exclusion machine-readable: Go code: - Add `undocumented bool` field to `BaseEngine` with explanatory comment - Add `IsUserFacingDocumented() bool` to the `Engine` interface and implement it on `BaseEngine` (returns !undocumented; default true) - Set `undocumented: true` on AntigravityEngine in NewAntigravityEngine() with a comment referencing the maintainer decision and the issue - Add `GetDocumentedEngines() []string` to EngineRegistry, which filters engines by IsUserFacingDocumented() for drift-detector use Tests (pkg/workflow/spec_test.go): - TestSpec_Engine_GetDocumentedEngines: asserts antigravity is absent from GetDocumentedEngines() and present in GetSupportedEngines() - TestSpec_Engine_IsUserFacingDocumented: asserts correct value per engine Workflow (daily-doc-updater.md): - Step 4: add documented-engines-only rule instructing DDUw to run `grep -r "undocumented:" pkg/workflow/` before flagging engine gaps - Step 1c: add intentionally-undocumented engine early-exit check and rejection-awareness guard (skip fix directions with >=2 closed PRs) Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
Triage | Category: Recommended action: Score breakdown: impact=25 (behavior fix, engine-critical path), urgency=15 (recent, no CI yet), quality=11 (no CI, good description)
|
|
🤖 Great work on this fix! This PR elegantly encodes the The changes are focused and well-tested:
This PR is ready for review. 🎯 Warning Firewall blocked 1 domainThe following domain was blocked by the firewall during workflow execution:
network:
allowed:
- defaults
- "patchdiff.githubusercontent.com"See Network Configuration for more information.
|
antigravityis production-registered but intentionally excluded from user-facing docs. Because that exclusion was purely social (maintainer PR closures), drift detectors had no machine-readable signal and kept re-filing the sameengines.mdgap — 13 duplicate issues in 7 days.Go:
pkg/workflow/Engineinterface — newIsUserFacingDocumented() boolmethod; default implementation onBaseEnginereturns!undocumented(defaulttruefor all engines)BaseEngine— newundocumented boolfield; whentrue, excludes the engine from drift-detector reconciliation without affecting runtime availabilityEngineRegistry— newGetDocumentedEngines() []stringreturns only engines whereIsUserFacingDocumented() == true; this is the set detectors must reconcile against instead ofGetSupportedEngines()NewAntigravityEngine()— setsundocumented: truewith a comment referencing the maintainer decision historyTests:
pkg/workflow/spec_test.goTestSpec_Engine_GetDocumentedEngines— assertsantigravityabsent fromGetDocumentedEngines(), present inGetSupportedEngines()TestSpec_Engine_IsUserFacingDocumented— asserts correct value per engineWorkflow:
.github/workflows/daily-doc-updater.mdgrep -r "undocumented:" pkg/workflow/; skip engines withundocumented: trueundocumented: trueengine, skip unconditionally regardless of closure state