Hi friends! Does anyone know if it's possible to (easily?) automatically extend the default provided appsettings-schema.json by Umbraco from an Umbraco package POV? Being able to ship an additional schema file isn't an issue, but it seems like I'll also need to be able to add an entry to the default appsettings-schema.json for it to be referenced 🤔

When in doubt, check what uSync does: https://github.com/KevinJump/uSync/pull/447

That's exactly what I did haha, though I thought that only created the actual schema file, not the reference to it! Will have a closer look though, thanks Patrick! 😄

Would love to hear if it actually works 😛 Then I can also add it to my packages

To ping or not to ping Kevin, that's the question 😂

@Corné Hoskam have you considered a separate settings file with a separate schema?

While possible, I feel like the best practise would be to stick with the 'default' / well known way of handling appsettings, where you stick with one appsettings.json file and have specific overrides per environment. This method would also require no additional loading of a json file. What would be the pro's and con's of going for a seperate settings file approach?

Pros: - you are not depedant on someone else's appsettings-schema.json - you don't have to mess with someone else's appsettings-schema.json - cleaner settings file with settings specific to your package (which also means cleaner appsettings.json files) - if you schema changes with a new version of the package, it's easier to update Cons - Load your own settings file including the environment variants (if applicable)

Hi yeah I am away from my desk, but we have a tool in the usync project for creating a schema file and Umbraco (v11+) has the feature where you add the targets and then you have your schema injected into the default one. Way easier (and safer) them messing about with the schema files yourself

Thank you Miguel and Kevin for the detailed information! I'll definitely be considering the options and looking at what uSync has done! 🙌

If you have a gist or bit of code to share would love to see it, I need to do exactly this soon

The basic gist for having it included would be to add a step in your build targets file that includes something along the following lines:

<UmbracoJsonSchemaFiles Include="$(MSBuildThisFileDirectory)..\appsettings-schema.CUSTOM.json"/>

where the Include is the path to the file in your nuget package. Umbraco will then copy over the file and include it as a reference in its own schema: https://github.com/umbraco/Umbraco-CMS/blob/86697ff137ab6a35d5279f4c1d6991093e1bb54c/src/Umbraco.Cms.Targets/buildTransitive/Umbraco.Cms.Targets.targets#L19C1-L19C1

Didn't know about the schema store. Very interesting, thanks!

Great stuff @Corné Hoskam ! Nice that you put it all together 😉