Installing exporters

Use your custom-built exporters in your design systems and workflows.

Whether you have customized an existing exporter or built a completely new one, you'll need to make them available to your workspace so they can be connected to the delivery pipelines. Here is how to do it.

Install an exporter from a repository

In Supernova, exporters are backed by repositories. You can link both public and private repositories. In the case of private repositories, you'll be prompted to authorize using OAuth or a private token, depending on the provider you have selected.

Follow these steps to install an exporter you've created or someone else's exporter from a GitHub, GitLab, Azure or Bitbucket repository.

Navigate to Code automation / Exporters / Custom.

Click + New custom exporter.

Enter a valid repository URL from either GitHub, GitLab, Bitbucket or Azure DevOps.

Click Confirm to install the exporter.

For private repositories: If you're not authorized yet, you'll be prompted to manage your platform authorization in settings.

Note that this only makes the exporter available to your organization and no one else — your code is secure with us.

Install an exporter from a branch or subdirectory

You can also install an exporter from a specific branch or subdirectory.

Navigate to Code automation / Exporters / Custom.

Click + New custom exporter

Enter a valid repository URL (including branches or subdirectories) from either GitHub, GitLab, Bitbucket or Azure DevOps.

Click Confirm to install the exporter.

Validating the exporter

To make sure your exporter is available to be used, head to the Exporters section and check that the exporter you have created is available there.

The list of all the installed exporters in your workspace

Uninstall an exporter

If you don't need the exporter anymore, you can remove it by hovering over the exporter in the Exporters section and clicking Uninstall. Click Confirm and the exporter is gone.

You can always re-add the exporter at the later time by linking the repository again

Deletion of an exporter will also automatically remove any pipeline you have created using that exporter package. You can of course always re-install the exporter and recreate the pipelines again at a later point.

Update a custom exporter

If you have installed an exporter before and you have made changes to its code since, you will need to force an update before the changes are applied to your pipelines.

This is essentially the same as npm packages — once the package is installed, a specific version is used until you bump the version of the package yourself.

Edit exporter settings

In the exporter settings you can update the repository, branch, or subdirectory settings.

Navigate to Code automation / Exporters, and open the exporter from the list.

You’ll see an overview of the exporter.

Click Settings to view the exporter settings.

You can update the platform and URL here.

Click Update to fetch the new branch and / or subdirectory.

Exporter versioning

Each exporter defines the package version. This is done through declaration of version property in the exporter.json file.

Before you update the package in Supernova, make sure you have bumped a version of the exporter to be higher than before (for example, from 1.0.1 to 1.0.2), following semantic versioning structure. If you don't do that, the update will be rejected with and info message saying "Your exporter is already up to date."

Pull latest version

To pull the latest version of an exporter:

Navigate to Code automation / Exporters.

From there, click into the Settings for the selected exporter.

Once in the exporter settings, you can click Pull latest version which will download the updated contents of the base repository that hosts the exporter.

That's all! Your exporter is now updated to the new version and every build / pipeline that will be created onwards will use this new version of the exporter package.

If you have made the exporter public and the exporter is used by more workspaces than yours, the update will be propagated to all pipelines that use it immediately across the entire Supernova.

Pipelines are used in production environments and so you should be absolutely sure that everything works before you push an update. We run extensive testing of the exporters before releasing the updates to core Supernova exporters.