Versioning
The Opaque platform comprises multiple independently versioned components. This section explains how versioning works across these components and how compatibility is ensured.
Versioned components
The Opaque platform uses different version types, each impacting specific aspects of its functionality. The following table summarizes the types of versions you'll manage.
Version type | Description | Where to view in Opaque | Distinct for each |
---|---|---|---|
Opaque version | The version of the Opaque app your organization is using | Footer of each page | Organization |
Compatible Opaque version | The common version a workspace uses to ensure feature compatibility | Details page | Workspace |
How compatibility works
- Multiparty workspaces: If a workspace includes members from different organizations running different Opaque versions, only features supported across all members’ versions will be available.
- Single-party workspaces: Compatibility is based solely on the Opaque version your organization is using.
The compatible Opaque version ensures that all members in a workspace can collaborate seamlessly. It reflects the lowest common version among all members for multiparty workspaces or the current version in single-party workspaces.
Versioning format
All the components described above are semantically versioned as shown in the following image.
- Major updates introduce breaking changes.
- Minor updates add new features in a backward-compatible way.
- Patch updates provide backward-compatible bug fixes.
Note
All workspace members must use the same major version of Opaque when collaborating.