Skip to content

Publish and version packages

Publishing means uploading your Designer automation to Zoan Cloud, where it is saved as a package with a version number. Only after publishing it can you create a process and run it unattended or scheduled.

Every time you publish, a new version of the package is created. Previous versions are preserved: they are never overwritten.

  1. Open your project in the Designer and verify that it works by running it locally. See Debugging.
  2. In the toolbar, click Publish.
  3. Indicates the version (see semantic versioning) and, optionally, release notes.
  4. Confirm. The Designer packages the project into a .zoan file and uploads it to your tenant.

publish modal with version and notes.

The package appears in the Packages section of the portal, ready to be associated with a process.

A .zoan package is a compressed file with your project. In its root it has a project.json manifest that describes the package:

{
"name": "Facturación",
"version": "1.2.0",
"entry": "playbooks/main.json"
}
FieldWhat it is
nameNombre del paquete
versionSemantic version of this post
entryMain playbook running first

You don’t need to edit this file by hand: the Designer generates it when publishing.

The versions follow the MAYOR.MENOR.PARCHE (semantic versioning) format. Each number communicates the change rate compared to the previous version:

Incrementa…WhenExample
PARCHEBug fixes, without changing behavior1.0.01.0.1
MENORNew functionality compatible with the previous1.0.01.1.0
MAYORChanges that modify expected behavior1.0.02.0.0

This tells whoever operates the process how risky it is to adopt the version: a PARCHE should be safe; a MAYOR requires validation before.

From Packages in the portal you see all the published versions of a package, with their date and notes. This gives you traceability: what changed, when and why.

  • Never modify an already published version. If you found a bug, publish a new version. A published version is immutable: thus a process pointing to 1.2.0 always executes exactly the same thing.
  • Write release notes even if they are brief (“corrects VAT calculation”). Your future self will appreciate it.
  • Test locally before publishing, and validate the version in the Test environment before pointing Production to it.
  • Go up from PATCH/MINOR/MAJOR depending on the actual change, so the number means something.