Skip to content

Say local viam-agent and viam-server binaries need a file:// URL - #5438

Merged
Eliza Farley (elizafarley) merged 1 commit into
mainfrom
claude/update-version-control-local-file
Oct 17, 2026
Merged

Eliza Farley (elizafarley) merged 1 commit into
mainfrom
claude/update-version-control-local-file

Conversation

@shannonbradshaw

Copy link
Copy Markdown
Collaborator

Source changes

  • APP-17968 — app#14007: saving a machine's version control with a bare local path (/home/me/viam-server, C:\...) now fails with viam-server version "/home/me/viam-server" looks like a local file path; did you mean "file:///home/me/viam-server"? instead of a version lookup error. The in-app help now says local files must start with file://.

Documents: no DOCS ticket found (Jira queried for APP-17968 and its parent APP-17913; no match).

Docs changes

  • docs/reference/viam-agent.md ("Version control") and docs/fleet/system-settings.md ("Agent version control"): both said the version can be "a URL to a custom binary" and never said how to point at a binary already on the machine. Added that it takes a file:// URL, with the Unix and Windows examples the app's own help text uses, and that the app won't save a bare path (localFilePathRegex in app/data/config_validation.go). viam-agent handles file:// URLs in version_control.go and utils/utils.go.

How I found these

  • Grep: version_control, version control, Software Updates, file://, custom binary, does not exist across docs/, static/include, data, layouts. Only these two pages describe the setting; neither mentioned file://.

Generated by daily docs change agent


Generated by Claude Code

app#14007 (APP-17968) rejects a bare local path in version control with a
'did you mean file://...' error.
@netlify

netlify Bot commented Oct 17, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 3b546c9
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6ad33e965c7baf69be0c77f9
😎 Deploy Preview https://deploy-preview-5438--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 38 (🟢 up 2 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Oct 17, 2026
@elizafarley

Copy link
Copy Markdown
Contributor

Docs review: Ready to merge

Adds one sentence to the version control sections of fleet/system-settings.md and reference/viam-agent.md: a binary already on the machine must be given as a file:// URL, and the app won't save a bare path. Every claim checks out against viamrobotics/app and viamrobotics/agent.

CI: All required checks passing

Docs health: No regressions

Verified against source (4 claims)
  • The app rejects a bare Unix or Windows absolute path for the agent or viam-server version and suggests the file:// form: viamrobotics/app data/config_validation.go:167 (localFilePathRegex), :217-220
  • This applies to both viam-agent and viam-server versions, so "same options as agent" on the viam-server bullet still holds: viamrobotics/app data/config_validation.go:207-210
  • The examples file:///home/myuser/viam-agent and file://C:\Users\myuser\viam-agent.exe match the app's in-product help text: viamrobotics/app ui/src/lib/components/config-cards/machine-settings-card/documentation/agent-version-control.md:12 (the doubled backslash there is JSON escaping; single backslashes are correct for the UI field)
  • viam-agent copies a local binary for a file:// URL: viamrobotics/agent utils/utils.go (DownloadFile, case "file"), version_control.go:248

Automated review by Claude. Rerunning the review updates this comment.

@elizafarley
Eliza Farley (elizafarley) merged commit c210fee into main Oct 17, 2026
15 checks passed
@elizafarley
Eliza Farley (elizafarley) deleted the claude/update-version-control-local-file branch October 17, 2026 13:48
@github-actions

Copy link
Copy Markdown

🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

safe to build This pull request is marked safe to build from a trusted zone

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants