Strapi 5 support for Config Sync

Finally Strapi 5 is here! After months of testing with the beta and release candidates we can now get our hands on the stable version of Strapi 5. And we're excited to announce that starting today you can install Config Sync version 2.0.0 in your Strapi 5 application!

What's new

In this article you can read about what has changed in Config Sync in order to release this new major version.

Document service

One of the biggest changes in Strapi 5 is the new Document service. It's an abstraction on Strapi's query layer which allows multiple entries to be grouped as one document. So all translations, drafts and revisions will all be considered as one document with it's own CUID unique `documentId`.

I'm pleased to tell you that Config Sync has been migrated to the document service to make full use of these new features of Strapi 5!

Document ID

As I just mentioned, in Strapi 5 entries will have a new unique identifier called `documentId`. This ID is used to find, update and delete entries through the various API's that Strapi offers.

As for Config Sync, this new document ID will actually be part of your JSON config files. Meaning that it will be included in the sync process, causing the document ID to be the same on all your environments. This allows you to query your config types manually in your application if needed. As apposed to the `id` in strapi 4, which could differ between environments and could not be used in such a manner.

Yalc playground

The Config Sync repository has been updated to allow for faster development using yalc and a playground Strapi instance inside the repo. The contributing guidelines have been updated to reflect this change and should give you easy steps so you can start contributing to Config Sync!

We hope you enjoy this new version of Config Sync and are happy to use it with Strapi 5. If you find any bugs or have a feature request, please report an issue on Github and stay tuned for more Strapi 5 related news coming soon!