DOCS-4069: Clarify module upload version restrictions for same architecture #4384
Conversation
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
|
Just a reminder: If you'd like me to act on any feedback you have via Github comments, just type @Promptless in your suggestion and I'll get right on it! (I won't show up in the user dropdown, but I'll process any request that has @Promptless in the comment body.) |
|
👋 Thanks for contributing! A reviewer will look at it on the next working day! |
JessamyT
changed the title
docs/dev/tools/cli.md
Outdated
| You cannot upload two files for the same architecture with the same version number. | ||
| You must increment to a new version number, even if you delete a previous version. |
There was a problem hiding this comment.
[s] rephrase from negative 'cannot' to positive 'can'. switch from technically-incorrect 'two' term (technically, you cannot upload more than one, but that's wordy as hell).
| You cannot upload two files for the same architecture with the same version number. | |
| You must increment to a new version number, even if you delete a previous version. | |
| Each architecture distribution for a given version of a module is immutable. | |
| You can delete the version, but you can never change an uploaded architecture distribution. | |
| To update your module, increment to a new version number. |
Sidenote: right now we overload the term 'version' to refer to both:
- numbered releases of a module
- the artifacts uploaded for each architecture
Most package managers, etc would refer to the per-architecture artifacts as distributions. I suggest we do the same here, and potentially above (change 'version' in the following sentence to 'distribution'):
For example, if you upload your module with support for `any/amd64` and then also upload with support for `linux/amd64`, a machine running the `linux/amd64` architecture deploys the `linux/amd64` version, while a machine running the `darwin/amd64` architecture deploys the `any/amd64` version.
It would probably be worthwhile to do the same on the rest of this page, and potentially add the term 'distribution' to the glossary or at least define it on this page as well. Otherwise we'll be stuck mucking about with ambiguity every time we want to refer to this concept! If that's too much scope creep, feel free to create a ticket and assign me -- I have a pretty good notion of how to handle it.
…3b0e-20250606-001736
JessamyT
deleted the
docs-update-a4656b99-5edc-44c1-aef0-15dfcd843b0e-20250606-001736
branch
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs' |
Based on user feedback, add clarification to the CLI documentation that you cannot upload two files for the same architecture with the same version number. This addresses a common confusion point where users might try to upload multiple files with identical version numbers and architectures, which is not allowed by the system.
Trigger Events
If you want Promptless to make further changes on this PR, feel free to leave a comment tagging Promptless (It won't show up in the user drop down but Promptless will get it!)