Releases

This document provides information about Sveltia CMS releases, including how to find release notes, versioning practices, and update instructions.

Release Frequency

Sveltia CMS ships new versions frequently, usually multiple times per week or even multiple times per day. Instead of following a strict release schedule, we prioritize releasing updates as soon as they are ready. This approach allows us to deliver new features, improvements, and bug fixes to users more rapidly.

This approach works because our product is a SPA served via a CDN. There is usually no maintenance overhead for users to update their installations — end-users can always access the latest version of Sveltia CMS without needing to manually update their software — as long as you use the CDN version.

Release Information

Here are some ways to stay informed about new releases:

• Our release notes are available on GitHub. You can star the repository to receive notifications about new releases.
• Major and minor releases are also announced on our Bluesky account. Follow us there for the latest updates!
• Interested in what’s coming next? Check out our roadmap. We have a lot of exciting ideas to make Sveltia CMS the best Git-based CMS out there.
• Deprecated features and breaking changes are documented in the migration guide.

Versioning Policy

We follow semantic versioning for our releases. We don’t typically maintain multiple release lines, but we may do so for critical security fixes if necessary.

Breaking changes are only introduced in major version updates (e.g., from 1.x.x to 2.0.0). Minor and patch releases (e.g., from 1.0.0 to 1.1.0 or 1.0.1) are backward-compatible, though unintended issues may occasionally arise.

Stable Version Not Yet Available

At this point, Sveltia CMS has not reached 1.0.0, so breaking changes may still occur in minor version updates. We’ll announce breaking changes clearly in the release notes.

Checking Your Current Version

You can view the current version of Sveltia CMS you are using by enabling Developer Mode in the application:

1. Click on your avatar in the top right corner of the application to open the Account menu.
2. Click Settings.
3. Click the Advanced tab.
4. Enable Developer Mode.
5. Close the Settings dialog.

A Release Notes link will now appear under the Account menu, displaying the current application version.

Updating Your Installation

CDN Usage

Updating Sveltia CMS when using the CDN is automatic, unless you have pinned to a specific version. The CDN always serves the latest version, so you don’t need to take any action to receive updates.

To use the latest version of Sveltia CMS via the CDN, include the following script tag in your HTML, as the start guide suggests:

<script src="https://unpkg.com/@sveltia/cms/dist/sveltia-cms.js"></script>

Module Version

Earlier versions of Sveltia CMS were bundled as a JavaScript module, so you needed type="module" in the script. The current version is a classic IIFE script, so the type attribute is no longer necessary. If you still need to use the module version for some reason, you can use this URL instead:

https://unpkg.com/@sveltia/cms/dist/sveltia-cms.mjs

The CMS also periodically checks for updates and notifies you when a new version is available. When you see the notification, simply click the “Update Now” button to refresh the application and load the latest version.

To avoid major version updates that may include breaking changes, you can pin to a specific major version using the caret symbol (^) followed by the major version number:

<script src="https://unpkg.com/@sveltia/cms@^1/dist/sveltia-cms.js"></script>

Stable Version Not Yet Available

At this point, Sveltia CMS has not reached 1.0.0, so breaking changes may still occur in minor version updates. Pinning to a specific major version is more relevant once we start releasing stable versions (1.0.0 and above).

You can also pin to an exact version, but this is not recommended unless you have a specific reason, like debugging or temporarily avoiding a problematic release:

<script src="https://unpkg.com/@sveltia/[email protected]/dist/sveltia-cms.js"></script>

NPM Package Usage

If you’ve chosen to install the CMS using a package manager, updating the package is your responsibility. We strongly recommend using ncu or a service like Dependabot to keep dependencies up to date. Otherwise, you’ll miss important bug fixes and new features.

ProTip

We update our dependencies using ncu -u && pnpm up at least once a week.

The pinning methods described in the CDN section above also apply to NPM package versions. For example, to pin to a specific major version, you can run:

npm

npm install @sveltia/cms@^1

yarn

yarn add @sveltia/cms@^1

pnpm

pnpm add @sveltia/cms@^1

bun

bun add @sveltia/cms@^1

See the NPM semantic versioning documentation for more details on version ranges.