Publishing and versioning

Module versioning allows builders to safely and iteratively build Workshop applications; the version accessible to end users can be controlled by publishing a stable version of the module. This allows for continuous development on a live Workshop application without necessarily exposing changes to end users when the module is saved.

Version History and Settings

Versions dialog

The Versions dialog is where builders can view a history of the saved versions for a module. Each saved version displays a timestamp, editor, and description if available. For each saved version, builders have the option to:

  • Publish this version: Publish a saved version of a module that will be accessible to viewers.
  • View this version: View the module at that specific version. When viewing a non-published version, a warning banner will appear at the top of the module.

Version warning banner

  • Revert to this version: Save the historic version as the newest version of the module. A description detailing the revert action will be automatically generated.
Edit a previous version of a module

To edit a previous version of a module, follow the steps below: * Ensure the Automatically publish when saving toggle switch is off in the Versions dialog. * Revert to the version you would like to edit. * Create a duplicate copy of the selected version of the module with File > Duplicate File. * Revert the original module to the newest version, and make any desired edits to the duplicate copy you created.

The Versions dialog is also where builders can go to edit settings related to saving and versioning actions:

  • Automatically publish when saving: This toggle controls whether saving will automatically publish a new version.
  • Always prompt to add a version description when saving: This toggle controls whether the builder is prompted to add an optional description when saving a new version. Descriptions can be added to help document the changes being made to modules and build up a richer record of the module's history. Descriptions can be viewed, added, and edited in the module’s Versions dialog.
Version description prompt