Skip to content

Commit ee3b1f2

Browse files
authored
Update the Deploy a Module docs with instructions to upload the module to the registry first (#4839)
1 parent 2e8fe19 commit ee3b1f2

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

docs/operate/modules/deploy-a-module.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,15 @@ binary built for one architecture (for example, `linux/amd64`) is uploaded for a
177177
different one (for example, `linux/arm64`), resulting in exec format errors on the
178178
target machine.
179179

180+
If this is your first time deploying this module, you need to create it in the registry before uploading:
181+
182+
```bash
183+
viam module create --name <module-name> --public-namespace <your-namespace>
184+
```
185+
186+
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.
187+
If you used viam module generate, this step may have been done for you automatically.
188+
180189
The generator creates the workflow file at
181190
`.github/workflows/deploy.yml`. To use it:
182191

0 commit comments

Comments
 (0)