-
Notifications
You must be signed in to change notification settings - Fork 48
DOCS-4068: Clarify GitHub Actions version number requirements #4382
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOCS-4068: Clarify GitHub Actions version number requirements #4382
Conversation
✅ 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! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM mod one suggestion
docs/operate/get-started/other-hardware/create-module/_index.md
Outdated
Show resolved
Hide resolved
docs/operate/get-started/other-hardware/create-module/_index.md
Outdated
Show resolved
Hide resolved
🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs' |
Based on user feedback from the Slack conversation, improve the module creation and management documentation to clarify two critical requirements for GitHub Actions cloud build:
[0-9]+.[0-9]+.[0-9]+
(semantic versioning with exactly 3 numbers separated by periods), not just "don't prepend with v". Users were confused when tags like "0.1" didn't trigger builds.2. Requiredviam module update
Step: Document that users must runviam module update
before cloud build will work, as this was causing build failures with the error "you must update the module withviam module update
before starting a cloud build".These clarifications will help users avoid common pitfalls when setting up automated module builds and provide better troubleshooting guidance when builds don't trigger as expected.
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!)