Publishing a package
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 the latest release by entering your published package address.
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
Open your package workspace properties
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 (usev=latestfor the most recent)#/API/CreateRelease— creates a new release (POST withreleaseNotes)#/Releases/— folder where release ZIPs are storedRelease Fileschema — 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
Bump Version on the package folder. It must be valid semver —
x.y.zwith non-negative integers. Releasing the same version twice is rejected.Visit your published package URL
The page lists current versions and any pending changes — files modified since the last release
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, a workspace admin can install it from the Packages tab of the workspace root by entering the package's published address. Docly opens <address>/Install?v=latest, which hands the release ZIP back to the workspace, and unpacks it under #/<encoded package address>/ in the workspace.
Docly also has a server-side install that calls the package directly: POST <address>/API/Info (package information as JSON) and <address>/API/Get?v=<version> (the release ZIP). When an install fails, test those two calls — API/Info must be called with POST.
Note: The Packages tab always installs the latest release.
Dependenciesare not installed, and removing a package from the list deletes its folder under#/.
Updating installed packages
Docly checks for new releases of every package installed from an address. The version numbers are the file names in #/Releases/ — 1.4.2.zip is release 1.4.2 — read on the Docly server that publishes the package. The check runs about every 30 minutes, so a new release can take up to half an hour to show up in other workspaces.
Versions are compared number by number, so 1.10 is newer than 1.9. A leading v is ignored, and a release with a suffix after a dash (2.0.0-beta) counts as older than the same version without it.
When a newer release exists, workspace admins see a notice on the workspace root, and the Packages tab shows the installed version, the newest version and an Update button. Update installs the latest release the same way as a new install, replaces the package folder under #/, and moves the previous folder to the recycle bin.
No notice is shown when Docly does not know one of the versions: when the package is published from a server outside Docly, has no releases, or the installed version is unknown.
Installed packages are read-only. Because an update replaces the whole folder, nobody can edit files under
#/<package address>/— change the package and cut a new release instead. See Installed packages are read-only.