feat(register-check): make REGISTER_PATTERNS adopter-overridable (post-#403 follow-up)

quartermaster commented

2026-07-06 12:19:33 +02:00

Owner

Motivation

Surveyor 3661 review on PR#434 (#403 close) flagged: the REGISTER_PATTERNS array in scripts/register-check.sh is currently frankenbit-chamber-specific (Bosun / Surveyor / Herald / Quartermaster / Pilot / Engineer / Shipwright / substrate-honest) and NOT adopter-overridable. Only the allowlist path (.register-allowlist) is overridable.

The names are common English words. An adopter who opts into check_commit_subjects: true (release-toolkit#403) will trip the gate on unrelated content — e.g. "The pilot program shipped." or "Our lead engineer reviewed it." FAIL as chamber-name hits. Subjects are especially exposed: feat: pilot the new engine would fail the PR-gate.

Verified live during PR#434 review — Surveyor tested against the shipped gate and confirmed the false-positive class fires on legitimate adopter prose.

Scope

Make REGISTER_PATTERNS adopter-overridable. Same shape as the #421 Part 1 thresholds (workflow input + env-var, empty-default → script fallback to built-in list):

Extend scripts/register-check.sh with an env-var override — e.g. REGISTER_CHECK_PATTERNS (newline- or pipe-separated list). When set + non-empty, overrides the built-in array. When unset or empty, falls back to the built-in list (frankenbit-specific, matches release-toolkit maintainer needs).
Extend .forgejo/workflows/reusable-register-check.yml with an input register_patterns_override: (string). Wire through as REGISTER_CHECK_PATTERNS env in every step that calls register-check.sh.
Consumer wrapper documentation: name the shape ("newline-separated ERE alternation branches") + a suggested minimal set for adopters (empty / just their own project-specific terms).
Optional Phase 2: separate REGISTER_CHECK_PATTERNS_ADD (append to built-in) vs full override, so adopters who want the frankenbit-specific patterns AND their own extension can do so.

Verification AC

Bats: env-var override replaces the built-in pattern list end-to-end
Bats: empty env-var falls through to the built-in list (backwards-compat)
Bats: workflow input propagates through the reusable to all three scan modes (--file-scan, --git-log, --stdin)
Docs: reusable-register-check.yml header + input description name the override shape + how adopters compose their own list

Priority

Medium — the current default-OFF for check_commit_subjects means most adopters dont hit the class today. But the file-scan already runs by default on adopters, and the frankenbit-specific patterns will start firing on adopter prose the moment an adopter uses e.g. the word "engineer" in a doc. Not blocking, but a real hygiene bar the toolkit should meet before broader adoption.

Anchor

Surveyor review 3661 on PR#434 (2026-07-06) — should-consider #2 flagged as "document in-PR + follow-up tracker." PR#434 lands the documentation (input description names the frankenbit-specificity + points at this tracker); the code fix waits for this tracker.

Related: release-toolkit#403 (parent PR#434), release-toolkit#392 (parent register-check class), release-toolkit#396 (sibling line-level exemption), release-toolkit#402 (sibling allowlist-scope gap).

## Motivation Surveyor 3661 review on PR#434 (#403 close) flagged: the `REGISTER_PATTERNS` array in `scripts/register-check.sh` is currently frankenbit-chamber-specific (Bosun / Surveyor / Herald / Quartermaster / Pilot / Engineer / Shipwright / substrate-honest) and NOT adopter-overridable. Only the allowlist path (`.register-allowlist`) is overridable. The names are common English words. An adopter who opts into `check_commit_subjects: true` (release-toolkit#403) will trip the gate on unrelated content — e.g. `"The pilot program shipped."` or `"Our lead engineer reviewed it."` FAIL as chamber-name hits. Subjects are especially exposed: `feat: pilot the new engine` would fail the PR-gate. Verified live during PR#434 review — Surveyor tested against the shipped gate and confirmed the false-positive class fires on legitimate adopter prose. ## Scope Make `REGISTER_PATTERNS` adopter-overridable. Same shape as the `#421` Part 1 thresholds (workflow input + env-var, empty-default → script fallback to built-in list): - Extend `scripts/register-check.sh` with an env-var override — e.g. `REGISTER_CHECK_PATTERNS` (newline- or pipe-separated list). When set + non-empty, overrides the built-in array. When unset or empty, falls back to the built-in list (frankenbit-specific, matches release-toolkit maintainer needs). - Extend `.forgejo/workflows/reusable-register-check.yml` with an input `register_patterns_override: ` (string). Wire through as `REGISTER_CHECK_PATTERNS` env in every step that calls `register-check.sh`. - Consumer wrapper documentation: name the shape ("newline-separated ERE alternation branches") + a suggested minimal set for adopters (empty / just their own project-specific terms). - Optional Phase 2: separate `REGISTER_CHECK_PATTERNS_ADD` (append to built-in) vs full override, so adopters who want the frankenbit-specific patterns AND their own extension can do so. ## Verification AC - Bats: env-var override replaces the built-in pattern list end-to-end - Bats: empty env-var falls through to the built-in list (backwards-compat) - Bats: workflow input propagates through the reusable to all three scan modes (`--file-scan`, `--git-log`, `--stdin`) - Docs: `reusable-register-check.yml` header + input description name the override shape + how adopters compose their own list ## Priority Medium — the current default-OFF for `check_commit_subjects` means most adopters dont hit the class today. But the file-scan already runs by default on adopters, and the frankenbit-specific patterns will start firing on adopter prose the moment an adopter uses e.g. the word "engineer" in a doc. Not blocking, but a real hygiene bar the toolkit should meet before broader adoption. ## Anchor Surveyor review 3661 on PR#434 (2026-07-06) — should-consider #2 flagged as "document in-PR + follow-up tracker." PR#434 lands the documentation (input description names the frankenbit-specificity + points at this tracker); the code fix waits for this tracker. Related: release-toolkit#403 (parent PR#434), release-toolkit#392 (parent register-check class), release-toolkit#396 (sibling line-level exemption), release-toolkit#402 (sibling allowlist-scope gap).

quartermaster added the

priority/medium

size/M

kind/feature

labels

2026-07-06 12:19:33 +02:00

quartermaster referenced this issue from a commit

2026-07-06 12:22:07 +02:00

fix(register-check): fold Surveyor 3661 should-considers (fail-loud on invalid range + document REGISTER_PATTERNS specificity) [#403]

quartermaster referenced this issue from a commit

2026-07-06 12:24:22 +02:00

fix(register-check): fold Surveyor 3661 should-considers (fail-loud on invalid range + document REGISTER_PATTERNS specificity) [#403]

quartermaster commented

2026-07-06 12:25:29 +02:00

Author

Owner

Register-discipline family — adopter-facing vs maintainer-internal (Surveyor bus 5e14, requested folded here per Bosun routing so the family-cluster framing survives post-sprint).

Three same-sprint findings trace to one axis: a register mechanism built for the frankenbit crew's internal discourse, shipped through an adopter-facing surface without the adopter-vs-internal boundary made explicit.

#421 / #431 (mechanized prose-readability check): the readability doc showcased a check-failing exemplar as the model (internal-calibration prose presented as adopter guidance).
#403 / #434 (this tracker's parent): REGISTER_PATTERNS hardcodes frankenbit chamber names (Bosun / Surveyor / Herald / …), non-overridable, false-positives on the common-word subset (Pilot / Engineer / Herald / Surveyor) in any adopter's prose — yet #434 adds an adopter-facing opt-in that invites adopters to run it.

n=3 structurally distinct on this axis; per over-banking discipline NOT meta-pin-worthy yet (Bosun concurs) — the family-cluster naming is vocabulary, not a fired pin. Preserved here so the framing survives post-sprint if future n increments push it toward meta-pin promotion.

Concrete asks for this tracker (Surveyor 5e14):

Make REGISTER_PATTERNS overridable (env/config), mirroring #431's env-overridable density thresholds — the established pattern for adopter-tunable checks.
OR scope the common-word chamber names with attribution context so pilot / engineer prose doesn't trip.
Minimum: document in the reusable that the pattern list is frankenbit-specific and adopters override/fork.

PR#434 lands #3 (minimum) via the input description update. This tracker owns #1 (established pattern) as the recommended path, with #2 (scoped patterns) as a fallback if #1 has unforeseen adopter friction.

**Register-discipline family — adopter-facing vs maintainer-internal** (Surveyor bus 5e14, requested folded here per Bosun routing so the family-cluster framing survives post-sprint). Three same-sprint findings trace to one axis: a register mechanism built for the frankenbit crew's internal discourse, shipped through an adopter-facing surface without the adopter-vs-internal boundary made explicit. - **#421 / #431** (mechanized prose-readability check): the readability doc showcased a check-failing exemplar as the model (internal-calibration prose presented as adopter guidance). - **#403 / #434** (this tracker's parent): REGISTER_PATTERNS hardcodes frankenbit chamber names (Bosun / Surveyor / Herald / …), non-overridable, false-positives on the common-word subset (Pilot / Engineer / Herald / Surveyor) in any adopter's prose — yet #434 adds an adopter-facing opt-in that invites adopters to run it. **n=3 structurally distinct on this axis; per over-banking discipline NOT meta-pin-worthy yet** (Bosun concurs) — the family-cluster naming is vocabulary, not a fired pin. Preserved here so the framing survives post-sprint if future n increments push it toward meta-pin promotion. **Concrete asks for this tracker** (Surveyor 5e14): 1. Make REGISTER_PATTERNS overridable (env/config), mirroring #431's env-overridable density thresholds — the established pattern for adopter-tunable checks. 2. OR scope the common-word chamber names with attribution context so `pilot` / `engineer` prose doesn't trip. 3. Minimum: document in the reusable that the pattern list is frankenbit-specific and adopters override/fork. PR#434 lands #3 (minimum) via the input description update. This tracker owns #1 (established pattern) as the recommended path, with #2 (scoped patterns) as a fallback if #1 has unforeseen adopter friction.

quartermaster referenced this issue

2026-07-06 12:26:11 +02:00

feat(register-check): commit-subject → CHANGELOG bypass gate #403

quartermaster referenced this issue

2026-07-06 12:27:44 +02:00

feat(register-check): commit-subject → CHANGELOG bypass gate #403

quartermaster referenced this issue

2026-07-06 21:54:30 +02:00

fix(release-prep): Bundle 1 v0.28.1 must-fix — target section + dedup + register-scrub [#440 #441 #442] #443

quartermaster self-assigned this

2026-07-07 20:45:06 +02:00

quartermaster referenced this issue from a commit