Skip to content

DOCS-3816: Add workflow permissions to update module instructions #4178

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

Closed
JessamyT wants to merge 2 commits into from
Closed

DOCS-3816: Add workflow permissions to update module instructions #4178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e534a7
DOCS-3816: Add workflow permissions to update module instructions
JessamyT Apr 1, 2025
76d25b5
Move to alert
JessamyT Apr 2, 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
11 changes: 11 additions & 0 deletions docs/operate/get-started/other-hardware/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1067,6 +1067,17 @@ The `viam module generate` command already generated the `build-action` file in
1. Click **Publish release**.
The cloud build action will begin building the new module version for each architecture listed in your <file>meta.json</file>, and any machines configured to use the latest release of the module will receive the update once it has finished building.

{{% alert title="Troubleshooting tip" color="tip" %}}

If you are having trouble with your GitHub Actions workflow, try the following:

In your GitHub repository **Settings**, navigate to **Actions** -> **General** -> **Workflow permissions**.
Set the **Workflow permissions** to **Read and write permissions**.

Then try triggering a build with a new release.

{{% /alert %}}

See [Update an existing module using a GitHub action](/operate/get-started/other-hardware/manage-modules/#update-automatically) for more information.

{{% /tab %}}
Expand Down
11 changes: 11 additions & 0 deletions docs/operate/get-started/other-hardware/manage-modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,17 @@ For more details, see the [`upload-module` GitHub Action documentation](https://
1. Push a tag or create a [release](https://docs.github.com/en/repositories/releasing-projects-on-github) in GitHub to trigger the build.
Once the build is complete, the module will automatically update in the [Viam Registry](https://app.viam.com/registry), and the machines set to use the latest [version](/operate/reference/module-configuration/#module-versioning) of the module will automatically update to the new version.

{{% alert title="Troubleshooting tip" color="tip" %}}

If you are having trouble with your GitHub Actions workflow, try the following:

In your GitHub repository **Settings**, navigate to **Actions** -> **General** -> **Workflow permissions**.
Set the **Workflow permissions** to **Read and write permissions**.

Then try triggering a build with a new release.

{{% /alert %}}

### Update manually

Use the [Viam CLI](/dev/tools/cli/) to manually update your module:
Expand Down
Loading