{description}
- Replace all
{repo}
with the actual repository name. - Replace all
{organization}
with the actual organization name (e.g.,wippyai
). - Replace all
{namespace}
with the actual module namespace (e.g.,wippyai
). - Replace all
{Package Name}
with the actual human-readable package name. - Replace the
{description}
with the actual package description. - Fill the
.github/CODEOWNERS
with the actual owners.- Configure access to the repository for the owners in https://github.com/{organization}/{repo}/settings/access
- Check that the
LICENSE
file is present and contains the correct license information. - Customize the
CONTRIBUTING.md
file with the actual contribution guidelines or remove it if not needed. - Fill the blocks below with the actual information or remove them if not needed.
The repository uses the Github Action
to automatically register the module in the Wippy registry on every release.
To trigger the registration, you need to create a new tag in the format vX.Y.Z
(e.g., v1.0.0
).
Before you can use the action, you need to set up the following repository secrets.
PRIVATE_REPO_TOKEN
- a token with permissions to clone the private repositorywippyai/module-registry-proto
.MODULE_ID
- the UUID of the module in the Wippy registry.WIPPY_USERNAME
- the UUID of the user in the Wippy registry.WIPPY_PASSWORD
- the password for the user in the Wippy registry.
Register in Wippy registry and use PackCli tool to generate the MODULE_ID
and WIPPY_USERNAME
/WIPPY_PASSWORD
credentials.