Skip to content
Runesmith Hub

Runesmith Hub

Publishing guide

Publish a plugin

Publishing a plugin on the hub takes a GitHub repository, a manifest and a release. You never upload anything: the hub builds your plugin from the source at the commit you tag, checks it, signs it and offers it to Runesmith users.

The steps

  1. Build the plugin as two projects: a contracts project and an implementation project. The Runesmith plugin template creates both.
  2. Describe it in plugin.json, including the capabilities it needs and its images.
  3. Check it locally with the hub check tool. It runs the same checks as the hub.
  4. Register it once with the registration form. It prepares a pull request to the registry.
  5. Release a version by pushing a tag and creating a GitHub release. See Releasing.
  6. Follow the tracking issue the hub opens for your version. See What happens after you release.

Tiers

TierWhoWhat users see
OfficialPlugins published by RunesmithThe Official badge
VerifiedPublishers Runesmith has verified; every version is reviewed by a personThe Verified badge
UnverifiedEvery other plugin; versions are checked automaticallyThe Unverified label and a warning before installing

Every plugin starts unverified. Once you have a published version and meet the requirements, you can ask for verification.

Before you start

  • Your repository must be public on GitHub, with an OSI-approved license.
  • Each repository holds one plugin.
  • Read the publisher policy and the content policy. Registering means you accept them.