Repository navigation
fix(docs): say compose.yaml shares the host network, not a published port - #2456
Merged
Merged
Conversation
The install invariant said compose.yaml publishes the port on 127.0.0.1, but the file has network_mode: host and no ports key; docs/docker.md already says the container shares the host network and the server binds loopback itself. Restate the invariant the way compose.yaml and docs/docker.md do.
Contributor
Author
|
@Birfy review request for this exact tip: Tier T0, one file: the Nothing else rides along — the diff is the one sentence and nothing in |
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
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.
Fixes #2455
Owner: Dev-1
Written-by: Dev-1
Claim-Id: ec77e1fbeedc470289e30804a6afb098
Branch:
dev/1-doc-compose-publish(head repoHugoXK/FlyBot)Base:
334960bbdb43a9e69e7a1fab7a15200b6f42eea7(live main)Tier: T0 — one file under
docs/; the gate's own computation over this patch isT0,why []Diff: 1 file +1/−1
Tip:
6d97baee7c3fbb5018de306b054627bd9a1502d0— verified commit59d4435136f72f1cfab6682e5a3ecdd9ca3cb936(tree38e5f94b4abc05bcae95b2199c132d31b2de6697, single parent334960bbdb43a9e69e7a1fab7a15200b6f42eea7); the pushed head was generated from that same tree by the push pathWhat changed
docs/subsystems/install.mdinvariant 4 saidcompose.yaml"publishes the port on the host's127.0.0.1only". The shippedcompose.yamlhasnetwork_mode: hostand noports:key, so nothing is published — the web server binds127.0.0.1itself throughdocker/web.patch.yml. The same page's table row anddocs/docker.mdalready describe host networking, so the invariant was the only place contradicting the file it describes. The sentence now says the container shares the host's network and the server's own loopback bind is the only exposure; no port is published.Red first
No unit test is added (docs-only). The red is the contradiction and it is reproducible before the edit with a two-file check:
After the edit the same check prints
GREEN: the invariant and compose.yaml agreeand exits 0.Ran at the tip
Verified commit
59d4435136f72f1cfab6682e5a3ecdd9ca3cb936(tree38e5f94b4abc05bcae95b2199c132d31b2de6697, single parent334960bbdb43a9e69e7a1fab7a15200b6f42eea7):TZ=UTC ARCH_DOCS_BASE=334960bbdb43a9e69e7a1fab7a15200b6f42eea7 npm run verify— exit 0, 4843/4843 tests, fail 0 / cancelled 0: core 2851, social 574, tree 132, timeline 141, workflow 411, root.github+policy671, interop 37, live-e2e 26. Lint: core 77 warnings / 0 errors, plugin lint 36/9/2/16 warnings / 0 errors, interop 1 warning / 0 errors, live-e2e 0 warnings / 0 errors.ARCH_DOCS_BASE=334960bbdb43a9e69e7a1fab7a15200b6f42eea7 npm --prefix core run arch-docson the committed tree —arch-docs: OK (1 changed file(s)).node scripts/ds-bot-patches.mjs check/canonical(insideverify) —10 patches apply cleanly in order,patches/ds-bot/ is what generate writes (generate is a no-op);core/andpatches/untouched.node core/scripts/build-client.mjs --check(insideverify) — exit 0;client.jsuntouched.GREEN, exit 0.Not run
docs/docker.md) already said what this sentence now says.patches/ds-bot/: no file undercore/changed.Duplicate check
GitHub search on
repo:ThinkFlowLab/FlyBotfor "compose publishes the port", "network_mode host docs" and "docker port published compose" returns only closed #482, #1594 and #352; none describes this doc/code contradiction.Checkpoint
{
"pr": 2456,
"claim": "Dev-1",
"issue": 2455,
"summary": "The install page's invariant said compose.yaml publishes a port on 127.0.0.1, but the file has network_mode: host and no ports key, so nothing is published and the web server binds loopback itself. The invariant now says what compose.yaml and the Docker guide already say: host networking, the server's own loopback bind, no published port. One docs sentence; no code, patches or changelog fragment.",
"files": [
"docs/subsystems/install.md"
],
"checks": {
"ran": "TZ=UTC ARCH_DOCS_BASE=334960bb npm run verify",
"result": "green",
"at": "59d4435136f72f1cfab6682e5a3ecdd9ca3cb936"
},
"next": "none — ready for review"
}