fix(#2787): clarify broken-windows ship blocking enforcement (#2814)

* fix(#2787): clarify broken-windows ship blocking enforcement

* fix(#2787): update renderLedger header to clarify opt-in enforcement

* fix(#2787): address maintainer scope and wording review

---------

Co-authored-by: Tom Boucher <trekkie@nomorestars.com>
This commit is contained in:
Dennis Kim
2026-08-03 12:39:16 -04:00
committed by GitHub
parent d3ddcaba1c
commit 178ec00040
5 changed files with 54 additions and 6 deletions

View File

@@ -0,0 +1,5 @@
---
type: Fixed
pr: 2814
---
**`broken-windows` capability no longer claims ship blocking is unconditional** — the description now states that `/gsd-ship` blocking applies only when `workflow.windows_enforce` is enabled (default `false`); ledger tracking is unaffected. (#2787)

View File

@@ -3,7 +3,7 @@
"role": "feature", "role": "feature",
"version": "1.9.1", "version": "1.9.1",
"title": "Broken-windows ledger", "title": "Broken-windows ledger",
"description": "Cross-phase defect register accumulating stubs, TODOs, skipped tests, unrun verifies, and unmet truths into .planning/WINDOWS.md. Blocks /gsd-ship while any window is open unless explicitly waived with a recorded reason. Operationalizes GSD's no-defer discipline as a tracked, enforced artifact (issue #1950).", "description": "Cross-phase defect register accumulating stubs, TODOs, skipped tests, unrun verifies, and unmet truths into .planning/WINDOWS.md. When enforcement is enabled, it blocks /gsd-ship while any window is open unless explicitly waived with a recorded reason. Operationalizes GSD's no-defer discipline as a tracked artifact (issue #1950).",
"tier": "full", "tier": "full",
"requires": [], "requires": [],
"engines": { "engines": {

View File

@@ -433,7 +433,7 @@ const capabilities = {
"role": "feature", "role": "feature",
"version": "1.9.1", "version": "1.9.1",
"title": "Broken-windows ledger", "title": "Broken-windows ledger",
"description": "Cross-phase defect register accumulating stubs, TODOs, skipped tests, unrun verifies, and unmet truths into .planning/WINDOWS.md. Blocks /gsd-ship while any window is open unless explicitly waived with a recorded reason. Operationalizes GSD's no-defer discipline as a tracked, enforced artifact (issue #1950).", "description": "Cross-phase defect register accumulating stubs, TODOs, skipped tests, unrun verifies, and unmet truths into .planning/WINDOWS.md. When enforcement is enabled, it blocks /gsd-ship while any window is open unless explicitly waived with a recorded reason. Operationalizes GSD's no-defer discipline as a tracked artifact (issue #1950).",
"tier": "full", "tier": "full",
"requires": [], "requires": [],
"engines": { "engines": {

View File

@@ -1,10 +1,10 @@
/** /**
* Broken-windows ledger — enforced cross-phase defect register (issue #1950). * Broken-windows ledger — optionally enforced cross-phase defect register (issue #1950).
* *
* Manages `.planning/WINDOWS.md`: a cross-phase ledger of small defects (stubs, * Manages `.planning/WINDOWS.md`: a cross-phase ledger of small defects (stubs,
* TODOs, skipped tests, lint warnings, unrun verifies, unmet truths, deviations). * TODOs, skipped tests, lint warnings, unrun verifies, unmet truths, deviations).
* `/gsd-ship` blocks while any entry is `open`; an entry can be `waived` only * When `workflow.windows_enforce` is true, `/gsd-ship` blocks while any entry is
* with a recorded reason or `fixed`. * `open`; an entry can be `waived` only with a recorded reason or `fixed`.
* *
* LEAF MODULE — imports ONLY: node:fs, node:path. No other src/ imports. * LEAF MODULE — imports ONLY: node:fs, node:path. No other src/ imports.
* *
@@ -596,7 +596,7 @@ export function renderLedger(ledger: Ledger): string {
const header = [ const header = [
'# Broken Windows Ledger', '# Broken Windows Ledger',
'', '',
'> Cross-phase defect register. `/gsd-ship` blocks while `open_count > 0`.', '> Cross-phase defect register. With `workflow.windows_enforce` enabled, `/gsd-ship` blocks while `open_count > 0`.',
'> Waive with `gsd-tools windows waive <id> "<reason>"` (reason required).', '> Waive with `gsd-tools windows waive <id> "<reason>"` (reason required).',
'> Mark fixed with `gsd-tools windows fixed <id>`.', '> Mark fixed with `gsd-tools windows fixed <id>`.',
'', '',

View File

@@ -0,0 +1,43 @@
const { test } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('node:fs');
const path = require('node:path');
test('broken-windows capability description specifies enforcement is opt-in', () => {
const capabilityPath = path.join(__dirname, '..', 'capabilities', 'broken-windows', 'capability.json');
const capabilityJson = JSON.parse(fs.readFileSync(capabilityPath, 'utf8'));
assert.ok(
capabilityJson.description.includes('When enforcement is enabled') || capabilityJson.description.includes('workflow.windows_enforce'),
`capability.json description should state enforcement is opt-in, got: ${capabilityJson.description}`
);
// Re-anchored: the unqualified sentence on next ("Blocks /gsd-ship while any window is open") must not be present
assert.strictEqual(
capabilityJson.description.includes('Blocks /gsd-ship while any window is open'),
false,
'description must not contain unqualified unconditional ship blocking sentence'
);
// Behavioral gate contract test: verify the ship:pre gate is gated on workflow.windows_enforce
const shipGate = capabilityJson.gates.find(g => g.point === 'ship:pre');
assert.ok(shipGate, 'broken-windows capability must declare ship:pre gate');
assert.strictEqual(
shipGate.when,
'workflow.windows_enforce',
'ship:pre gate must be gated on workflow.windows_enforce config key'
);
// Behavioral test for renderLedger
const bw = require('../gsd-core/bin/lib/broken-windows.cjs');
const rendered = bw.renderLedger(bw.emptyLedger());
assert.strictEqual(
rendered.includes('> Cross-phase defect register. `/gsd-ship` blocks while `open_count > 0`.'),
false,
'renderLedger must not contain unqualified blocking sentence'
);
assert.ok(
rendered.includes('With `workflow.windows_enforce` enabled, `/gsd-ship` blocks'),
'renderLedger must document opt-in enforcement'
);
});