Document --annotation flag for viam module reload#5012
Document --annotation flag for viam module reload#5012shannonbradshaw wants to merge 2 commits intomainfrom
Conversation
The reload command gained an --annotation flag (rdk#5951, app#11729) that lets users describe the purpose of a reload build. The annotation is stored alongside the reload metadata in the machine config. https://claude.ai/code/session_01LW3uGKyHAqLD9xsZYQ296m
✅ 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
There was a problem hiding this comment.
Pull request overview
Documents the newly-added --annotation flag for viam module reload, ensuring CLI and module build docs reflect the updated reload workflow and metadata.
Changes:
- Added
--annotationto theviam modulenamed-arguments table in the CLI reference. - Added a
reload-specific flags summary paragraph (including--annotation) to the module reference, parallel to the existingreload-localflags paragraph.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/cli/reference.md | Documents --annotation as a named argument for viam module reload. |
| docs/build-modules/module-reference.md | Adds a consolidated reload flags list including the new --annotation flag. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| `reload` flags: `--part-id` (target machine part), `--path` (root of git | ||
| repo to build), `--annotation` (text note describing the purpose of this | ||
| reload build), `--model-name` (add a resource to config with this model | ||
| triple), `--resource-name` (name the resource instance), `--id` (module ID), | ||
| `--cloud-config` (path to `viam.json`, alternative to `--part-id`), | ||
| `--workdir` (subdirectory containing `meta.json`), `--local` (run entrypoint | ||
| directly on localhost). |
There was a problem hiding this comment.
The new reload flags summary omits --module, which is documented in the CLI reference as applicable to reload/reload-local for specifying a non-current-directory meta.json path. Add --module to this reload flags list (and consider adding it to the adjacent reload-local flags list for consistency/completeness).
There was a problem hiding this comment.
Fixed in 07a366b. Added --module to both the reload and reload-local flags paragraphs.
Generated by Claude Code
|
Hey @shannonbradshaw — CI is green and no reviewer is assigned yet. Could you request one when you have a chance? Auto-comment from overwatch. Will not re-nudge for 7 days. |
Source changes
--annotationflag toviam module reloadcommand andreload_annotationfield to the module configreload_annotationfield inAppModuleConfigDocs changes
docs/cli/reference.md: Added--annotationrow to the module named arguments table, alphabetically before--binarydocs/build-modules/module-reference.md: Added areloadflags paragraph listing all reload-specific flags including--annotation, parallel to the existingreload-localflags paragraphHow I found these
moduleFlagAnnotationconstant andStringFlaginrdk/cli/app.goreload command definitionannotation,reload_annotation,viam module reload— the flag was absent from the documented flagsreload(notreload-local) by checking the command definitions inrdk/cli/app.goGenerated by daily docs change agent
Generated by Claude Code