Registry
The registry is a YAML file that contains shortcuts to popular package’s git URLs. It’s used by Clockwork to install packages quickly. For example, a user might run this command:
clockwork add https://github.com/WearOSCommunity/example-ui-pkg.gitSince that package is already in the registry, the user can run this command instead:
clockwork add example-ui-pkgPackages in the registry
The component above dynamically fetches packages from the registry, so there’s no need to update the documentation when adding a package.
Requirements for a package to be added to the registry
If you meet all these requirements, feel free to create a pull request.
- The package must be open-source
- The package must have a package file containing metadata about the package in the root of the repository
- The package’s metadata must be accurate and fill all applicable fields
- e.g. if your package is a UI package, the
watchFaceFormatVersionfield must be filled
- e.g. if your package is a UI package, the
- The package’s name is not already reserved in the registry
Even if you meet all the requirements, your pull request may be rejected, but you are still encouraged to create a pull request if you haven’t already.
Recommendations for maintaining a package
- If you introduce breaking changes, you should document it and publish it as a major (e.g. 1.0.0 -> 2.0.0) release so Clockwork doesn’t automatically update it.
Adding your package to the registry
Fork and clone the repository
Fork the repository and then clone it:
git clone <your-fork-url>Add it to registry.yml
In this example, xml-preprocessor is the name of the package (used for installing, e.g. clockwork add xml-preprocessor) and url is the GitHub URL, which Clockwork will automatically resolve the latest version to install.
xml-preprocessor:
url: https://github.com/gondwanasoft/xml-preprocessor.git # git url to your package