Skip to content

docs(spikes): fix math error and UAPI protocol name in wireguard spike - #490

Merged
norrietaylor merged 1 commit into
mainfrom
fix/spike-486-wireguard-corrections-770025a40ce08a1d
Jun 20, 2026
Merged

docs(spikes): fix math error and UAPI protocol name in wireguard spike#490
norrietaylor merged 1 commit into
mainfrom
fix/spike-486-wireguard-corrections-770025a40ce08a1d

Conversation

@gominimal-aw-bot

@gominimal-aw-bot gominimal-aw-bot Bot commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Two post-merge correctness issues found by sdd-review on PR #488:

Changes

MEDIUM — Arithmetic fix (line 88 + action item 4)

The boringtun release gap (0.6.0 July 2023 → 0.7.0 January 2026) is ~30 months (~2.5 years), not ~18 months. The arithmetic:

  • July 2023 + 18 months = January 2025
  • July 2023 + 30 months = January 2026 ✓

The incorrect figure propagated into action item 4's risk-register checkpoint: "re-evaluate if no version is released within 18 months of the prior release." That threshold was calibrated against the wrong gap and would have triggered for any 19-month silence even though the historical gap was 30 months. Both occurrences are corrected.

LOW — Protocol name fix (line 71)

wireguard-go's subprocess interface is the WireGuard UAPI protocol — a line-based key=value text protocol over a Unix socket — not a "JSON configuration socket." Updated to "UAPI socket (a line-based key=value text protocol over a Unix socket)" for accuracy.

Proof

File assertion: docs/spikes/2026-06-20-wireguard-implementation.md contains no 18-month or JSON configuration text after this change, and contains ~30-month gap at lines 89 and 250, and UAPI socket at line 71.

$ grep -n '18.month\|JSON configuration' docs/spikes/2026-06-20-wireguard-implementation.md
(no output)
$ grep -n '30.month\|UAPI' docs/spikes/2026-06-20-wireguard-implementation.md
71:    via its UAPI socket (a line-based key=value text protocol over a Unix
89:  pace had an ~30-month gap between 0.6.0 (July 2023) and 0.7.0 (January 2026,
250:4. **Risk register entry:** Note that boringtun exhibited an ~30-month release
255:   30 months of the prior release.

Refs #488

Generated by sdd-execute (sonnet tier) for issue #488 ·

Summary by CodeRabbit

  • Documentation
    • Refined WireGuard implementation technical documentation with updated specifications for integration approaches and protocol details.
    • Clarified architecture descriptions to improve accuracy of technical implementation information.
    • Adjusted maintenance timeline expectations and updated risk assessment checkpoints to better reflect expected maintenance cadence and evaluation criteria.

@coderabbitai

coderabbitai Bot commented Jun 20, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 55d82be1-8d3a-4829-8873-0b32002c3002

📥 Commits

Reviewing files that changed from the base of the PR and between b89e3c6 and 62b3ecc.

📒 Files selected for processing (1)
  • docs/spikes/2026-06-20-wireguard-implementation.md

📝 Walkthrough

Walkthrough

Three factual corrections applied to the WireGuard implementation spike document: the wireguard-go subprocess integration socket is relabeled from a JSON configuration socket to a UAPI socket; the boringtun maintenance gap is revised from ~18 months to ~30 months (~2.5 years); and the risk-register action item is updated to match the ~30-month cadence with the 0.6.0 (July 2023) → 0.7.0 (January 2026) version date range.

Changes

WireGuard Spike Document Factual Corrections

Layer / File(s) Summary
Socket terminology, maintenance gap, and risk register
docs/spikes/2026-06-20-wireguard-implementation.md
Relabels the wireguard-go socket from JSON configuration to UAPI; revises the boringtun maintenance gap from ~18 months to ~30 months (~2.5 years); updates the risk-register cadence checkpoint to the ~30-month figure with explicit 0.6.0 → 0.7.0 date range and a re-evaluate condition.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

Possibly related PRs

  • gominimal/minimal#488: Edits the same boringtun maintenance-risk section and risk-register language in the same spike document, making it a direct predecessor of the corrections in this PR.

Poem

🐇 Hippity-hop, I fixed the doc's gap,
Thirty months now, not eighteen — mind the map!
UAPI socket, not JSON I say,
The boringtun figures are right today.
With version dates penned and the register aligned,
These factual hops leave no errors behind! 🌿

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: fixing a math error (18 months → ~30 months) and correcting the UAPI protocol name (JSON configuration socket → UAPI socket) in the WireGuard spike documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

@norrietaylor
norrietaylor enabled auto-merge (squash) June 20, 2026 05:17
@norrietaylor
norrietaylor merged commit 5bd89f2 into main Jun 20, 2026
16 checks passed
@norrietaylor
norrietaylor deleted the fix/spike-486-wireguard-corrections-770025a40ce08a1d branch June 20, 2026 05:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant