Skip to content

Release and roll back a plugin

Treat the source plugin, SDK dependency, and browser artifact as one release.

Release checklist

  1. Pin the approved SDK package version.
  2. Increment the plugin's own version when behavior or options change.
  3. Type-check and build the standalone artifact.
  4. Test preboot ordering on a nonproduction page.
  5. Verify registration becomes ready.
  6. Inspect pluginErrors on every affected route.
  7. Record the artifact digest, target site, owner, and release date.
  8. Retain the previously tested artifact for rollback.

Use required: false for optional customer enhancements so an isolated plugin failure does not stop the base configurator.

Artifact naming

Use a stable, descriptive browser filename when the hosting system replaces releases atomically:

text
dealer-experience.plugin.js

Use immutable versioned URLs when the customer CDN cannot guarantee cache invalidation:

text
dealer-experience.1.4.2.plugin.js

Rollback

Restore the previously tested artifact or URL, reload the page, and verify:

js
const status = await window.iConfigurator.ready()
console.log(status.getPluginStatus('customer.dealer-experience'))

Unregistering a plugin through the browser API is useful for diagnosis but is not a persistent rollback. A configured or preboot plugin returns on reload until its descriptor or script is changed.

Icon Visualizer developer documentation