DOCS-1060, DOCS-1091: Add GitHub Action upload #1782
Conversation
viambot
added
the
safe to build
|
Hi @abe-winter ! Sorry for Friday ping: here's the docs around your awesome github action |
| You can update an existing module in the [Viam Registry](https://app.viam.com/registry) in one of two ways: | ||
|
|
||
| - [Upload a newer version of your module manually](#update-an-existing-module-using-the-viam-cli) using the [Viam CLI](/manage/cli/). | ||
| - [Upload a newer version of your module automatically](#update-an-existing-module-using-a-github-action) as part of a continuous integration (CI) workflow, using a GitHub Action. |
There was a problem hiding this comment.
phrasing slightly confusing bc it sounds like you are doing this once
might change to 'upload new versions' or 'automatically upload on release' or something
(but this is a nit)
| 1. Next, follow the instructions to [Create an organization API key](/manage/cli/#create-an-organization-api-key), which the action will use to authenticate its run. | ||
| Provide the `key-id` and `key-value` generated in the YAML configuration above. | ||
|
|
||
| 1. Push a commit to your module or [create a new release](https://docs.github.com/en/repositories/releasing-projects-on-github). |
There was a problem hiding this comment.
'each commit' vs 'only github release' vs 'only tag release' workflows are subtly different
I didn't doc too deeply in the action's README.md because this is a general github thing, not a viam thing. your call whether to say anything about it here, but FYI
There was a problem hiding this comment.
Thank you, added a "your specific steps may differ" callout. 👍
andf-viam
force-pushed
the
DOCS-1060-add-registry-github-action-docs
branch
from
9391770 to
7c67a56
Compare
Co-authored-by: Naomi Pentrel <[email protected]>
Co-authored-by: Naomi Pentrel <[email protected]>
Co-authored-by: Naomi Pentrel <[email protected]>
|
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/d392353b3548f3f917763e63c3ba3b7fd4c7291e/public |
Add instructions to update an existing module in the Viam Registry using the new GitHub action
upload-modulefrom https://github.com/viamrobotics/upload-module.app.viam.com/modulesslug to newapp.viam.com/registry, except for module pages themselves, which still usemodulesingular.registryeverywhere per recent guidance.Staging