Skip to main content

How to Version, Deprecate or Delete a Plugin in a Stack

In this section, you will find how to version, deprecate, or delete the version of a Plugin in the Stack.


Create a Plugin Version

Plugins Versioning follows the semantic standard (SemVer).

When standardizing SemVer, you can choose one of the types below:

  • Specific version: represents a single version of the Plugin, such as 1.0.0.

  • Range: in the sequence 1.0.0, 1.2.3, 1.2.4, 1.2.5, 1.2.6, 1.3.1., the ~1.2.3 or >1.2.3. represents any version greater than or equal to >=1.2.3 and less than <1.3.0. In the range, you can define a range of versions allowed for the Plugin, such as ~1.2.3. You can only change a version range's PATCH and MINOR. The MAJOR range does not change.

danger

In some scenarios it impossible to publish a version of a Plugin that is lower than MAJOR's range, because this breaks version compatibility. See below for other actions that break the MAJOR of a range:

  • Adding/Removing new Connection Interfaces, both in the requires and generates attributes.
  • Adding/Removing Plugins.
  • Removing inputs.
  • Addition of inputs required without default value.

Scenario to create a version

Plugin Versioning happens in two scenarios:

Scenario 1. When there is an error in the Plugin.
Scenario 2. When adding some new functionality to the Plugin.

warning

Check if your Team belongs to the Studio where the Plugin is. If someone removed your Team from the Studio, you cannot work on it anymore.

Versioning a Plugin

To version a Plugin in a Stack, go to the StackSpot Platform and follow the steps below:

Step 1. In the Stack, click on the Plugin section and then on 'Add Plugins';

Step 2. In the side tab, click on the arrow button of the Plugin you want to add to your Stack;

Step 3. Select a single version or select the range of versions and enter the example version ranges.;

Step 4. Click on the Plugin checkbox and then click on the button 'Add Plugins'.

Deprecate a Plugin version

tip

For more information, access the deprecation rules page.

When you deprecate a Plugin version within the Stack, any published instance of the Plugin will show a deprecation flag.

Users of the deprecated Plugin version will receive an email notification.

To deprecate a version, follow these rules:

  1. You need content deprecation permission;

  2. You must belong to the Studio where the Plugin version will be deprecated unless you have the Account Holder role.

To deprecate the version of a Plugin in a Studio, log in to the StackSpot Platform and follow the steps below:

warning

Deprecating a version is irreversible.

Steps to deprecate the Plugin version in the Stack

Step 1. In your Studio, enter the Stack where the Plugin is located and then click on the 'Plugins' tab;

Step 2. Click on the Plugin;

Step 3. On the left-side menu, in the Version History section, click 'Version'. Choose the version you want to deprecate and click on 'Deprecate Version' to deprecate this Plugin's version.

You've deprecated a version of the Plugin.

Delete a Plugin

tip

For more information, access the deletion rules page.

You can remove a version of a published Plugin from a Stack, Studio, or Starter. Deleting a version from a Stack severs its connection within the Stack, but the Plugin version persists in the Studio.

tip

When the sole version of a Plugin is published and deleted, the Plugin is entirely removed. To delete a Plugin fully, delete all its published versions.

To delete a version, adhere to the following rules:

  1. The Plugin version must not be in use or associated with any Stack.

  2. You need permission to remove content.

warning

Deleting a version of content is irreversible. However, to recover the content, you can recreate the deleted version or generate a new one.

To delete the version of a Plugin in a Studio, log in to the StackSpot Platform and follow the steps below:

Step 1. In your Studio, access the Plugin section and choose the Plugin to delete;

Step 2. In the Plugin description, click the button indicating the current version;

Step 3. On the left-side of the screen, find 'Version History'. Click on the button beside the version of the Plugin you want to remove;

Step 4. Complete the required fields:

  • The slug and the version of the Stack you want to remove.

To proceed, click 'Delete Plugin'.

Remove a Plugin from a Stack (Optional)

At StackSpot, removing the version of a Plugin in a Stack is possible. However, you can only remove it if the Stack it is in a has yet to be published state.

Check the step-by-step process to remove a Plugin from a Stack:

Step 1. Enter the Stack that the Plugin is in. Click on the 'Plugin' tab;

Step 2. In the Stack Plugins listing, click on the 'More Options' ('...') button of the Plugin you want to remove;

Step 3. Click on the 'Remove' button to remove the Plugin.