Skip to content
Qatium Logo Qatium Logo Qatium SDK Documentation
We're currently creating a lot of content. Sign up to get notified when it's ready.

Prepare for publishing

Congratulations! You’ve come a long way and your plugin is ready for submission. Publishing your plugin will let you share it with the Qatium community for everyone to use.

Before submitting your plugin, follow these guidelines to ensure it meets all the publication requirements.

1. Check your plugin works as expected

Take some time to test your plugin thoroughly, and verify the use cases it addresses work as expected. We’ll also test your plugin upon submission and during the review process, so be ready to explain how it works.

2. Check your manifest file and icon

The manifest and icon files are important pieces of your plugin, as they help Qatium correctly classify it in our infrastructure.

Make sure:

  • You’ve set your plugin’s name correctly
  • You’ve configured the correct permissions
  • You‘ve created a unique icon for your plugin

3. Check the review guidelines

Take a look at the review guidelines and check whether your plugin follows them. Make any changes you need before submitting.

The Qatium team will be guiding you throughout the review process: we’ll let you know if you haven’t followed any guidelines.

4. Pack your plugin

Now that everything is checked and works as expected, it’s time to pack your plugin. First, create a new build using NPM.

Terminal window
npm run build

This command should have generated a new dist directory, with the following structure:

Terminal window
dist
├ plugin.js # (or plugin.zip for python)
├ index.html
├ icon.svg
└ manifest.json

This is the final structure of your plugin as it will be submitted to Qatium. You can verify that the plugin works correctly by loading it from the built files and using the developer mode, with the following NPX command:

Terminal window
cd dist
npx http-server --port 8888 --cors

After loading your plugin using developer mode, it should work as it did before building.

5. Submit your plugin

When you’re ready, pack your files into a ZIP file. You can use the following command:

Terminal window
zip -r my-plugin.zip dist

Finally, submit your plugin for review to Qatium using the submission form. We will get in touch with you as soon as possible with the next steps through email.

Make sure you document how your plugin works and how to test it thoroughly in the submission form. This is very important step to help the review team have a good understanding of your plugin, and will make approval easier.

Submit your plugin

6. Submitting updates

If you want to update your plugin, just follow the same steps you used to publish it for the first time. When your code is ready for the update, submit it using the submission form.