Skip to content

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

Conversation

promptless[bot]
Copy link
Contributor

@promptless promptless bot commented Jun 5, 2025

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:

  1. Tag Format Requirements: Make it explicit that release tags must follow the exact pattern [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. Required viam module update Step: Document that users must run viam module update before cloud build will work, as this was causing build failures with the error "you must update the module with viam 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!)

Copy link

netlify bot commented Jun 5, 2025

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 202f3ed
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6843394d5a513c0008f55a1e
😎 Deploy Preview https://deploy-preview-4382--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: 50 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 70 (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.

@CLAassistant
Copy link

CLAassistant commented Jun 5, 2025

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ JessamyT
❌ promptless[bot]
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Contributor Author

promptless bot commented Jun 5, 2025

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.)

@viambot
Copy link
Member

viambot commented Jun 5, 2025

👋 Thanks for contributing! A reviewer will look at it on the next working day!

@JessamyT JessamyT changed the title docs: Clarify GitHub Actions cloud build requirements and troubleshooting DOCS-4068: Clarify GitHub Actions version number requirements Jun 5, 2025
Copy link
Member

@nathan-contino nathan-contino left a 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

@JessamyT JessamyT merged commit 57f361b into main Jun 6, 2025
12 of 13 checks passed
@JessamyT JessamyT deleted the docs-update-c239cb7d-325e-4c04-89b4-1c9f0dbcd311-20250605-234928 branch June 6, 2025 22:28
Copy link

github-actions bot commented Jun 6, 2025

🔎💬 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
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants