docs: surface the Tunnel.setup/2 → setup/1 break in the 0.6.7 changelog - #49
Open
GenericJam wants to merge 1 commit into
Open
docs: surface the Tunnel.setup/2 → setup/1 break in the 0.6.7 changelog#49GenericJam wants to merge 1 commit into
GenericJam wants to merge 1 commit into
Conversation
Reported by @dl-alexandre in #25. His literal claim — that the arity change isn't in the 0.6.x changelog — is not quite right: it was there, as a parenthetical at the end of a long "Fixed" bullet about dist-port keying. His actual complaint stands though. Tunnel.setup/1 is @doc'd, @SPEC'd public API that shows up in hexdocs, out-of-tree callers break at compile time, and nobody scanning a changelog for breaking changes reads to the end of a bullet about EPMD port collisions. Pulled it into its own "Breaking" section on 0.6.7 with the exact compile error and the one-line fix, and marked it as noted retroactively so the history stays honest about when it was actually surfaced. No version bump: the changelog for a shipped release is being corrected, not the code. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
GenericJam
force-pushed
the
docs/surface-tunnel-setup-break
branch
from
September 1, 2026 20:17
68a2fda to
ada2eaa
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #25.
@dl-alexandre's literal claim is slightly off — the arity change was in the changelog. But it was a parenthetical at the end of a long
### Fixedbullet about EPMD dist-port collisions, which is not where anyone scanning for breaking changes will find it.His underlying point holds:
MobDev.Tunnel.setup/1is@doc'd and@spec'd public API that appears in hexdocs, so an out-of-tree caller (his custom deploy Mix task) breaks at compile time. That deserves its own heading.Pulled it into a
### Breakingsection on 0.6.7 with the exact compile error and the one-line fix, marked as noted retroactively so the history stays honest about when it was actually surfaced.Changelog only — no version bump, since this corrects the record for a shipped release rather than changing code.
🤖 Generated with Claude Code