From 54b3c806acc4d5b6b6246dfcbc340fe6b854b60f Mon Sep 17 00:00:00 2001 From: Julie Krasnick <99275379+jckras@users.noreply.github.com> Date: Wed, 18 Mar 2026 17:27:01 -0400 Subject: [PATCH 1/6] Update deploy-a-module.md --- docs/operate/modules/deploy-a-module.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/operate/modules/deploy-a-module.md b/docs/operate/modules/deploy-a-module.md index 5c341e685e..ab8ab5b9d9 100644 --- a/docs/operate/modules/deploy-a-module.md +++ b/docs/operate/modules/deploy-a-module.md @@ -167,9 +167,7 @@ Make sure all scripts are executable: ```bash chmod +x setup.sh build.sh run.sh ``` - ### 3. Deploy with cloud build (recommended) - Cloud build is the recommended way to deploy modules. It uses GitHub Actions to compile your module for every target platform automatically, so you don't need to cross-compile locally. This eliminates a common class of errors where a @@ -177,6 +175,14 @@ binary built for one architecture (for example, `linux/amd64`) is uploaded for a different one (for example, `linux/arm64`), resulting in exec format errors on the target machine. +If this is your first time deploying this module, you need to create it in the registry before uploading: +```bash +viam module create --name --public-namespace +``` +This registers the module ID so the registry knows about it. You only need to do this once — after that, builds and uploads will work. +If you used viam module generate, this step may have been done for you automatically. + + The generator creates the workflow file at `.github/workflows/deploy.yml`. To use it: From cf9c50e168479cb4523eb15c700ecd860b084982 Mon Sep 17 00:00:00 2001 From: Julie Krasnick <99275379+jckras@users.noreply.github.com> Date: Wed, 18 Mar 2026 17:34:16 -0400 Subject: [PATCH 2/6] Update deploy-a-module.md --- docs/operate/modules/deploy-a-module.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/operate/modules/deploy-a-module.md b/docs/operate/modules/deploy-a-module.md index ab8ab5b9d9..9ba6b74155 100644 --- a/docs/operate/modules/deploy-a-module.md +++ b/docs/operate/modules/deploy-a-module.md @@ -167,7 +167,9 @@ Make sure all scripts are executable: ```bash chmod +x setup.sh build.sh run.sh ``` + ### 3. Deploy with cloud build (recommended) + Cloud build is the recommended way to deploy modules. It uses GitHub Actions to compile your module for every target platform automatically, so you don't need to cross-compile locally. This eliminates a common class of errors where a From 225f4e282da73990e5edaddd1763e2f278b9cd3f Mon Sep 17 00:00:00 2001 From: Julie Krasnick <99275379+jckras@users.noreply.github.com> Date: Wed, 18 Mar 2026 17:36:45 -0400 Subject: [PATCH 3/6] Update deploy-a-module.md --- docs/operate/modules/deploy-a-module.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/operate/modules/deploy-a-module.md b/docs/operate/modules/deploy-a-module.md index 9ba6b74155..a545dc5c14 100644 --- a/docs/operate/modules/deploy-a-module.md +++ b/docs/operate/modules/deploy-a-module.md @@ -181,7 +181,7 @@ If this is your first time deploying this module, you need to create it in the r ```bash viam module create --name --public-namespace ``` -This registers the module ID so the registry knows about it. You only need to do this once — after that, builds and uploads will work. +This registers the module ID so the registry knows about it. You only need to do this once, after that, builds and uploads will work. If you used viam module generate, this step may have been done for you automatically. From b322f8dc57cba1550cbab5649fbbf2bd5c36bee9 Mon Sep 17 00:00:00 2001 From: Julie Krasnick <99275379+jckras@users.noreply.github.com> Date: Wed, 18 Mar 2026 17:39:13 -0400 Subject: [PATCH 4/6] Update deploy-a-module.md --- docs/operate/modules/deploy-a-module.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/operate/modules/deploy-a-module.md b/docs/operate/modules/deploy-a-module.md index a545dc5c14..ff4e84013a 100644 --- a/docs/operate/modules/deploy-a-module.md +++ b/docs/operate/modules/deploy-a-module.md @@ -178,6 +178,7 @@ different one (for example, `linux/arm64`), resulting in exec format errors on t target machine. If this is your first time deploying this module, you need to create it in the registry before uploading: + ```bash viam module create --name --public-namespace ``` From 99a3bdbff02e05d940a7550fcba22f9f6854ae37 Mon Sep 17 00:00:00 2001 From: Julie Krasnick <99275379+jckras@users.noreply.github.com> Date: Wed, 18 Mar 2026 17:41:06 -0400 Subject: [PATCH 5/6] Update deploy-a-module.md --- docs/operate/modules/deploy-a-module.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/operate/modules/deploy-a-module.md b/docs/operate/modules/deploy-a-module.md index ff4e84013a..75e9bd5be5 100644 --- a/docs/operate/modules/deploy-a-module.md +++ b/docs/operate/modules/deploy-a-module.md @@ -185,7 +185,6 @@ viam module create --name --public-namespace This registers the module ID so the registry knows about it. You only need to do this once, after that, builds and uploads will work. If you used viam module generate, this step may have been done for you automatically. - The generator creates the workflow file at `.github/workflows/deploy.yml`. To use it: From 84cf2f0da46d95730a14a422b4b13ce3d18a47fc Mon Sep 17 00:00:00 2001 From: Julie Krasnick <99275379+jckras@users.noreply.github.com> Date: Wed, 18 Mar 2026 17:42:46 -0400 Subject: [PATCH 6/6] Update deploy-a-module.md --- docs/operate/modules/deploy-a-module.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/operate/modules/deploy-a-module.md b/docs/operate/modules/deploy-a-module.md index 75e9bd5be5..e3668aaf97 100644 --- a/docs/operate/modules/deploy-a-module.md +++ b/docs/operate/modules/deploy-a-module.md @@ -182,7 +182,8 @@ If this is your first time deploying this module, you need to create it in the r ```bash viam module create --name --public-namespace ``` -This registers the module ID so the registry knows about it. You only need to do this once, after that, builds and uploads will work. + +This registers the module ID so the registry knows about it. You only need to do this once, after that, builds and uploads will work. If you used viam module generate, this step may have been done for you automatically. The generator creates the workflow file at