statamic / ideas

šŸ’”Discussions on ideas and feature requests for Statamic
https://statamic.dev
32 stars 1 forks source link

Add mention about changed statamic config file in changelog #1215

Open dadaxr opened 2 months ago

dadaxr commented 2 months ago

Regularly default statamic config files get updated ... but for existing project following updates through composer it's easy to miss some update impacting those config file.

I know there is no breaking change inside those updates, but some stuff get added, and then doc refer to it... but if we missed the update, some part are missing from our copied vendor files, and we get loss ;)

Also ... config files are a "quick" doc in a way... so it's important to stay up-to-date.

It would be really nice to have a notice message after a composer update mentioning vendor dist config file gets updated but I dont know if it's possible (technically speaking). So I was thinking ... It's maybe enough to simply write in plain sight within changelog that some config files get updated. It's actually how drupal (yeah I know drupal should not always be a reference, does it sometimes ?) is actually managing it... particularly with server config files (.htaccess for instance), or drupal default setting files)

2 examples : https://www.drupal.org/project/drupal/releases/7.99 =>

Changes have been made to default.settings.php but only within comments. No changes have been made to .htaccess, web.config or robots.txt files in this release, so upgrading custom versions of those files is not necessary.

and

https://www.drupal.org/project/drupal/releases/9.5.0

Changes to site-owner-managed files :
....

Another solution could be to keep default statamic config files in statamic vendor folder (so without publishing them) but publish a void skeletton with only a comment mentioning the main config file, and allow to orverride any keys. But not sure it's more usable.

Related discord thread : https://discord.com/channels/489818810157891584/1153390699161587823/1278188679449411595