Publish Plugin

In this section, you will find a guide on how to publish your Plugin on STK CLI. And how to version the Plugins.

Publishing on StackSpot means storing and making available the content of Stacks, Plugins, and Actions on the StackSpot platform so that other developers can use them. You manage who can access what you publish through the visibility settings of your Studio.

Publish your Plugin on the StackSpot Platform

You can only use your Plugin after adding it to a Stack and after that, add this Stack to a Workspace.

caution

Before publishing a Plugin, ensure the Slug (Identifier) is unique in the Studio. Having duplicate Slugs with the same ID (Stack, Plugin, or Action) in a Studio is not allowed.

Requirements

• STK CLI.
• A created Plugin.
• Permission to publish.

danger

In some scenarios, publishing a version of a Plugin that is lower than MAJOR's range is impossible because this breaks version compatibility. The following actions constitute breaking the major range:

• Adding/Removing new Connection Interfaces, both in the requires and generates attributes.

• Adding or Removing Plugins.

• Removing inputs.

• Adding inputs required without the default value.

Follow the steps below:

Step 1. Open your terminal and log in to STK CLI:

stk login

Step 2. Execute the following command in the Plugin's local folder:

stk publish plugin --studio studio-slug-name

STK CLI validates the YAMLs and files in your folder. Example:

• studio_slug: The Studio it is in.
• plugin_name: The Plugin name.
• version: If there is a valid Plugin version.

Your plugin.yaml is not validated when:

1. It shows inconsistencies.
2. The version you want to publish already exists in the Studio.
3. You do not have permission to publish.
4. The Plugin.yaml is not in the current folder.

info

If you still don't have any Studio to add your Plugin, go to the StackSpot Platform to create a Studio. For more information, see the guide.

Next steps

• Now that you have published your Plugin, you can manage its versions.
• It is also possible to Apply a Plugin which adds new capabilities to an Application.