You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/operate/modules/advanced/manage-modules.md
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ Once your module is in the [registry](https://app.viam.com/registry), there are
37
37
38
38
### Update automatically from a GitHub repo with cloud build
39
39
40
-
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:
40
+
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:
41
41
42
42
1. Edit your module code and update the [`meta.json`](/operate/modules/advanced/metajson/) file if needed.
43
43
For example, if you've changed the module's functionality, update the description in the `meta.json` file.
@@ -51,7 +51,7 @@ Use [GitHub Actions](https://docs.github.com/actions) to automatically build and
51
51
52
52
{{% alert title="Tip" color="tip" %}}
53
53
54
-
If you used `viam module generate` to create your module and enabled cloud build, and you followed all the [steps to publish your module with PyInstaller](/operate/modules/deploy-module/#package-and-upload-the-module) including adding API keys for the build action, all you need to do to trigger a new build is create a tag and publish a release in GitHub as you did when you first published the module.
54
+
If you used `viam module generate` to create your module and enabled cloud build, and you followed all the [steps to publish your module with PyInstaller](/operate/modules/deploy-module/#package-and-upload-the-module) including adding API keys for the build action, all you need to do to trigger a new build is publish a release in GitHub as you did when you first published the module.
55
55
56
56
{{% /alert %}}
57
57
@@ -66,9 +66,8 @@ Use [GitHub Actions](https://docs.github.com/actions) to automatically build and
66
66
67
67
```yaml
68
68
on:
69
-
push:
70
-
tags:
71
-
- "[0-9]+.[0-9]+.[0-9]+"
69
+
release:
70
+
types: [published]
72
71
73
72
jobs:
74
73
publish:
@@ -257,7 +256,7 @@ For more details, see the [`upload-module` GitHub Action documentation](https://
257
256
258
257
1. Add the key ID and value as GitHub repository secrets named `viam_key_id` and `viam_key_value`.
259
258
260
-
1. Push a tag or create a [release](https://docs.github.com/en/repositories/releasing-projects-on-github) in GitHub to trigger the build.
259
+
1. Create a [release](https://docs.github.com/en/repositories/releasing-projects-on-github) in GitHub to trigger the build.
261
260
The build can be quick or take over 15 minutes to complete, depending on factors including the size of the module.
262
261
263
262
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/advanced/module-configuration/#module-versioning) of the module will automatically update to the new version.
Copy file name to clipboardExpand all lines: docs/operate/modules/deploy-module.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -193,7 +193,7 @@ The `viam module generate` command already generated the `build-action` file in
193
193
194
194
1. From the main code page of your GitHub repo, find **Releases** in the right side menu and click **Create a new release**.
195
195
1. In the **Choose a tag** dropdown, create a new tag with a name consisting of three numbers separated by periods, following the regular expression `[0-9]+.[0-9]+.[0-9]+` (for example, `1.0.0`).
196
-
You must follow this format to trigger the build action.
196
+
You must follow this format.
197
197
For details about versioning, see [Module versioning](/operate/modules/advanced/module-configuration/#module-versioning).
0 commit comments