Migrating from Earlier Versions of Sveltia CMS

This page documents the key changes and deprecations when upgrading from earlier versions of Sveltia CMS.

Breaking Changes

Check the release notes for other changes that may affect your project when upgrading to the latest version of Sveltia CMS.

We’ll update this section with specific migration steps when we release version 1.0. For now, please refer to the deprecations listed below.

These options were added to Sveltia CMS 0.x but are now deprecated and will be removed in version 1.0:

The automatic_deployments backend option: Use the new skip_ci option instead, which is more intuitive. automatic_deployments: false is equivalent to skip_ci: true, and automatic_deployments: true is equivalent to skip_ci: false.
The save_all_locales i18n option: Use the initial_locales option instead, which provides more flexibility. save_all_locales: false is equivalent to initial_locales: all.
The omit_default_locale_from_filename i18n option: Use the new omit_default_locale_from_file_path i18n option instead, which applies to all multiple files/folders structures, not just multiple_files.
The multiple_folders_i18n_root i18n structure: Use the new multiple_root_folders i18n structure instead, which has a more intuitive name and the same file structure.
The {{fields._slug}} and {{fields._slug | localize}} slug template tags: Use the editable and i18n slug options instead. slug: '{{fields._slug}}' is equivalent to slug: { editable: true }, and slug: '{{fields._slug | localize}}' is equivalent to slug: { editable: true, i18n: true }.
The slug_length collection option: Use the maxlength option in the global slug options instead.
The yaml_quote collection option: yaml_quote: true is equivalent to quote: double in the new YAML format options.
The read_only UUID field option: Use the readonly common field option instead (which defaults to true for UUID fields).

The deprecated logo_url option will be removed in the future. Use the new logo.src option instead.