Document the C++ cloud build image#5213
Open
btshrewsbury-viam wants to merge 1 commit into
Open
Conversation
Add a note to the cloud build section explaining that C++ modules compile on a Debian-based Linux image (the same environment that builds the RDK), and how to install build dependencies via the module setup step. Closes #5208.
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
viambot
added
the
safe to build
btshrewsbury-viam
marked this pull request as ready for review
July 15, 2026 16:41
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
2 participants
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 #5208.
Adds a small reference note to the Cloud builds section of
docs/cli/build-and-deploy-modules.mddocumenting the environment Viam cloud build uses to compile C++ modules, and how a developer can match it locally.Image detail: documented conservatively (did not assert "Debian Bookworm")
The issue's premise is that C++ cloud builds run on a Debian Bookworm image. I could not confirm that exact codename from source, and one of the issue's own cited sources points the other way, so the note documents only the verifiable Debian fact:
viamrobotics/build-actionREADME.md). That layer is therdk-devenvimage, which upstream treats as a moving target (.canon.yamlupdate_interval), so pinning a codename in docs would go stale and be less accurate than the source's own contract.viamrobotics/viam-cpp-sdk#548generated the cloud-build lockfile from "the macos and bookworm jobs".viamrobotics/viam-cpp-sdk#616(merged 2026-04-20, after the 2026-04-03 announcement) is titled "fix bullseye cloud build", and the SDK is published for both Debian Bullseye and Bookworm. So a single "Bookworm" assertion is contradicted by the source.cli/module_generate/cpp-gen/Dockerfile.debian.bookworm, is (per its README) the dev container for the stub-generator tool (cl_gen), not the module cloud-build image. This is a likely (inference, low confidence) origin of the issue's Bookworm claim.The verified user-facing pattern is confirmed by the canonical
viamrobotics/module-example-cppexample: itsmeta.jsonbuildsetuprunsmake setup→apt-setup.sh, installing dependencies withapt-geton a Debian environment. The note points readers there.Placement
Additive note in the existing
## Cloud buildssection. No new page, no moves/renames/URL changes.Checks
prettier --write: clean (unchanged).markdownlint: pass.vale --minAlertLevel suggestion: no errors/warnings on the added lines (only pre-existing suggestions elsewhere on the page); RDK abbreviation resolved with a glossary tooltip.