Login

Publishing a package Last updated: 07. May 2026

Cut releases of your package using Docly Package Releaser — the official tool for making a package installable in other workspaces.

How releases work

A release is a snapshot of your package folder, zipped and stored under a version number. Other workspaces install a specific version (or latest) by pointing to your published package URL.

Releases are produced by Docly Package Releaser — itself a package, installed into the package workspace you want to publish. Once installed, it adds a small admin page and three API endpoints to your workspace.

Step 1: Install Docly Package Releaser

  1. Open your package workspace properties

  2. Go to the Packages tab and install Docly Package Releaser

The Releaser adds:

  • An index page at / showing package info, versions and the release UI

  • #/API/Info — returns package metadata and pending changes

  • #/API/Get?v=<version> — downloads a release ZIP (use v=latest for the most recent)

  • #/API/CreateRelease — creates a new release (POST with releaseNotes)

  • #/Releases/ — folder where release ZIPs are stored

  • Release File schema — describes each entry in #/Releases/

Step 2: Publish the workspace

Publish the workspace folder to a URL — that URL is what consumers will install from. See Publish in Getting Started for the basic flow.

Step 3: Cut a release

  1. Bump Version on the package folder. It must be valid semver — x.y.z with non-negative integers. Releasing the same version twice is rejected.

  2. Visit your published package URL

  3. The page lists current versions and any pending changes — files modified since the last release

  4. Click Create new release, enter release notes, and confirm

Behind the scenes, every file in the package folder is zipped (#/Releases/ itself is excluded) and stored as #/Releases/<version>.zip along with a Release File document recording the date and notes.

Authorization

Only users with AllowAdmin access on the package folder can release. The release UI is hidden for everyone else, and CreateRelease rejects unauthorized requests.

Manage access through the folder's share settings.

Consuming a published package

Once a release exists, any workspace can install it via the standard Packages tab — point at your package's published URL. The workspace fetches #/API/Get?v=latest (or a specific version), unpacks the ZIP and copies the contents in.

Tip: Pin to a specific version in production. latest is convenient for development but exposes you to surprises when a new release lands.