Documentation
Developers
Publishing a Plugin to the Hub

Publishing a Plugin to the Hub

With the announcement of CloudQuery Hub, we are excited to see the community contribute plugins to the Hub. This guide will walk you through the process of publishing a plugin to the Hub.

Prerequisites

  • You have created a CloudQuery Cloud (opens in a new tab) account and completed the onboarding process to create a team
  • You have the CloudQuery CLI installed (version >= v5.0.0)
  • The plugin you'd like to publish is written in one of the following:
    • Go with SDK version >= v4.17.1
    • Python with SDK version >= v0.1.12
    • JavaScript with SDK version >= v0.1.0
  • The plugin you'd like to publish is initialized using the plugin's name, team and kind. See example here (opens in a new tab)
  • You are authenticated to CloudQuery Cloud (opens in a new tab) using the cloudquery login command

Create a Plugin Definition on Hub

Before publishing a plugin, you need to create a plugin definition on the CloudQuery Cloud site.

Log in to CloudQuery Cloud (opens in a new tab). If you have not created a team yet, you will be asked to create a new one.

The display name will be visible on Hub next to your plugin. The team name is going to be used in configurations to reference your plugin using <team-name>/<plugin-name>.

To create a new plugin definition, create a new plugin from the Plugins tab. Fill in the necessary details and upload the plugin image.

Staging Releases

Release your plugins for internal testing first before making it public. Set the Visibility to Private and Release Stage to Preview. This enables testing of premium plugins without being charged and with your team only (you can invite other users to your team to test the plugin). When you want to release the plugin in public, set the Visibility to Public and eventually, change the Release Stage to GA (Generally Available) to begin charging for the usage.

Publishing a Plugin

To publish a plugin to the Hub, follow the steps below depending on the language you are using.

  1. (Optional, recommended) In the root directory of your plugin repository run git tag v1.0.0 to tag the version you're about to publish (replace v1.0.0 with the version you'd like to publish).
  2. (Optional, recommended) Run git push origin v1.0.0 to push the tag.
  3. Run go run main.go package --docs-dir docs -m 'feat: Initial release' v1.0.0 . to package the plugin. v1.0.0 should match the tag you created in step 1. The -m specifies the changelog message that will be used in the release notes and it supports markdown. See example here (opens in a new tab). docs should be a directory containing markdown files that serve as documentation for the plugin. Read more about the documentation format here.
  4. Run cloudquery login to authenticate your CLI with CloudQuery.
  5. Run cloudquery plugin publish to publish a draft version of the plugin. The version will show up under the versions tab of your plugin in CloudQuery Cloud (opens in a new tab). As long as the version is in draft it's mutable and you can re-package the plugin and publish it again.
  6. Once you're ready run cloudquery plugin publish -f to publish a finalized version of the plugin. This version will be immutable and will show up in Hub (opens in a new tab) if the plugin is marked as public. Allow up to 1 hour for the Hub to reflect the changes.

Documentation Format

  • The only documentation format supported at the moment is markdown, and the cloudquery publish command will only upload markdown files with the .md extension
  • You can have multiple markdown files as documentation. The files will be concatenated in alphabetical order, and if one of the files is named overview.md it will show up first
  • The markdown filename will be title cased when display in the Hub. For example overview.md will be displayed as Overview
  • HTML tags are not supported in the markdown files and will be ignored
  • Relative assets (e.g. ./assets/logo.png) are not supported. We recommend using absolute URLs for assets e.g. https://raw.githubusercontent.com/<owner>/<repo>/main/assets/logo.png in case you have the assets on GitHub
Publishing an Addon to the HubGenerating Resources