docs(visual-regression): make starting the container runtime discoverable#82
Merged
Merged
Conversation
…able The Docker VRT flow (`--ci`) fails with a confusing "Cannot connect to the Docker daemon" error when the runtime is installed but not running — the most common snag, since Colima/Podman don't auto-start and stop on reboot. The docs covered installing Colima but never said you have to start it each session. - DOCKER.md: explain what Colima is (Docker daemon in a Linux VM, no Docker Desktop license), add a callout that it must be started (`colima start`) and doesn't auto-start, an optional resource flag, and a Troubleshooting section with a start/status table for all three runtimes. - README.md: the `--ci` note now says the runtime must be installed **and running**, and links the Troubleshooting section. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Why
Running the Docker-based visual-regression flow (
pnpm test:visual --ci) fails with a confusing "Cannot connect to the Docker daemon" error when the container runtime is installed but not running. On macOS the common backend is Colima, which (like Podman) does not auto-start and stops on reboot. The docs explained how to install Colima but never said you have to start it each session — so the failure mode isn't obvious.What changed
DOCKER.mddockerCLI works without Docker Desktop / its license).colima start, check withcolima status— and an optional--cpu/--memoryflag for heavy runs.--cirun fails before any test executes.README.md--cinote now says the runtime must be installed and running, names Colima/colima start, and links the Troubleshooting section.Docs-only; no code changes.
🤖 Generated with Claude Code