Skip to content

Update manage-modules.md #4686

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update manage-modules.md #4686

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1c7988
Update manage-modules.md
npentrel Oct 6, 2025
9b74963
Update manage-modules.md
npentrel Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/operate/modules/other-hardware/manage-modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Once your module is in the [registry](https://app.viam.com/registry), there are

### Update automatically from a GitHub repo with cloud build

Use [GitHub Actions](https://docs.github.com/actions) to automatically build and deploy your new module version when you create a tag or release in GitHub:
Use [GitHub Actions](https://docs.github.com/actions) to automatically build and deploy your new module version when you create a new release in GitHub or push a tag to GitHub:

1. Edit your module code and update the [`meta.json`](/operate/modules/other-hardware/create-module/metajson/) file if needed.
For example, if you've changed the module's functionality, update the description in the `meta.json` file.
Expand Down Expand Up @@ -65,6 +65,8 @@ Use [GitHub Actions](https://docs.github.com/actions) to automatically build and

```yaml
on:
release:
types: [published]
push:
tags:
- "[0-9]+.[0-9]+.[0-9]+"
Expand Down Expand Up @@ -256,7 +258,7 @@ For more details, see the [`upload-module` GitHub Action documentation](https://

1. Add the key ID and value as GitHub repository secrets named `viam_key_id` and `viam_key_value`.

1. Push a tag or create a [release](https://docs.github.com/en/repositories/releasing-projects-on-github) in GitHub to trigger the build.
1. Create a [release](https://docs.github.com/en/repositories/releasing-projects-on-github) in GitHub or push a tag to trigger the build.
The build can be quick or take over 15 minutes to complete, depending on factors including the size of the module.

Once the build is complete, the module will automatically update in the [registry](https://app.viam.com/registry), and the machines set to use the latest [version](/operate/modules/other-hardware/module-configuration/#module-versioning) of the module will automatically update to the new version.
Expand Down
Loading