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 changes that may affect your project during the beta period.
Version 0.x to 1.0
We’ll update this section with specific migration steps when we release version 1.0. For now, please refer to the deprecations listed below.
Deprecations
These options were added to Sveltia CMS 0.x but are now deprecated and will be removed in version 1.0:
- The
automatic_deploymentsbackend option: Use the newskip_cioption instead, which is more intuitive.automatic_deployments: falseis equivalent toskip_ci: true, andautomatic_deployments: trueis equivalent toskip_ci: false. - The
save_all_localesi18n option: Use theinitial_localesoption instead, which provides more flexibility.save_all_locales: falseis equivalent toinitial_locales: all. - The
omit_default_locale_from_filenamei18n option: Use the newomit_default_locale_from_file_pathi18n option instead, which applies to all multiple files/folders structures, not justmultiple_files. - The
multiple_folders_i18n_rooti18n structure: Use the newmultiple_root_foldersi18n structure instead, which has a more intuitive name and the same file structure. - The
{{fields._slug}}and{{fields._slug | localize}}slug template tags: Use theeditableandi18nslug options instead.slug: '{{fields._slug}}'is equivalent toslug: { editable: true }, andslug: '{{fields._slug | localize}}'is equivalent toslug: { editable: true, i18n: true }. - The
slug_lengthcollection option: Use themaxlengthoption in the global slug options instead. - The
yaml_quotecollection option:yaml_quote: trueis equivalent toquote: doublein the new YAML format options.
Future Plans
These features and options will be removed in a future release:
- The
logo_urloption: Use the newlogo.srcoption instead. - The flat keys of the
fieldsMetaDataprop: Use the nested path instead:fieldsMetaData.getIn(['books', 'author'])rather thanfieldsMetaData.get('books.0.author'), andfieldsMetaData.getIn(['tags', 'tag'])rather thanfieldsMetaData.get('tags')for the singlefieldof a List field.