• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    Use case developmentPilotHow-to guidesDeploy a custom widget

    Deploy a custom widget

    Deploying a widget set differs from deploying an application. A widget does not require an application-specific subdomain and does not use a Developer Console application. Instead, Pilot publishes your widget to the Widget Registry as a versioned release, which you can embed in a Workshop application.

    Implement ontology entities

    If your widget only references entities that already exist in the deployed ontology, you can skip this step.

    If Pilot proposed new or modified ontology entities while building your widget, promote them to Main first using Global Branching. See Implement ontology entities.

    Tag and release

    From the Deploy view, tag a release to publish a new version of your widget set. Tagging triggers Foundry CI to build the widget set and publish the version to the Widget Registry. For the underlying publishing mechanics and how versions are calculated, see Publish a widget set.

    Publishing a new version does not change existing usages of the widget. A Workshop application continues to use the version it was configured with until you update it to the new version.

    Embed the widget in Workshop

    Once your widget set is published, add the widget to a Workshop application and configure its parameters and events. See Embedding a widget in Workshop.

    Tagging and releasing a custom widget from the Deploy view.

    Release updates

    To ship changes, continue iterating in the Editor view, then return to the Deploy view and tag a new release. The new version is published to the Widget Registry, and you can update your Workshop application to use it.