Skip to content

Commit 44a5d53

Browse files
authored
DOCS-4459: Update github action to use release trigger (#4800)
1 parent 0b627d2 commit 44a5d53

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

docs/operate/modules/advanced/manage-modules.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Once your module is in the [registry](https://app.viam.com/registry), there are
3737

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

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:
4141

4242
1. Edit your module code and update the [`meta.json`](/operate/modules/advanced/metajson/) file if needed.
4343
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
5151

5252
{{% alert title="Tip" color="tip" %}}
5353

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

5656
{{% /alert %}}
5757

@@ -66,9 +66,8 @@ Use [GitHub Actions](https://docs.github.com/actions) to automatically build and
6666

6767
```yaml
6868
on:
69-
push:
70-
tags:
71-
- "[0-9]+.[0-9]+.[0-9]+"
69+
release:
70+
types: [published]
7271

7372
jobs:
7473
publish:
@@ -257,7 +256,7 @@ For more details, see the [`upload-module` GitHub Action documentation](https://
257256

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

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.
261260
The build can be quick or take over 15 minutes to complete, depending on factors including the size of the module.
262261

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

docs/operate/modules/deploy-module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ The `viam module generate` command already generated the `build-action` file in
193193

194194
1. From the main code page of your GitHub repo, find **Releases** in the right side menu and click **Create a new release**.
195195
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.
197197
For details about versioning, see [Module versioning](/operate/modules/advanced/module-configuration/#module-versioning).
198198

199199
1. Click **Publish release**.

0 commit comments

Comments
 (0)