Issue #7147 has been reported by Nick Fagerlund.

----------------------------------------
Bug #7147: settings.yml.example should be an inert file
https://projects.puppetlabs.com/issues/7147

Author: Nick Fagerlund
Status: Unreviewed
Priority: Normal
Assignee: 
Category: 
Target version: 
Keywords: 
Branch: 
Affected URL: 
Affected Dashboard version: 


Nick1 just told me something fascinating! Apparently 
config/settings.yml.example is a live configuration file responsible for 
maintaining the default settings. I guess it's consulted by Dashboard if it 
doesn't find a config/settings.yml file. 

I kind of salute the economy of that, but it's very magical and hence bad. 
Giving it a name with .example on the end sends a very clear message that the 
file is inert, which it isn't. 

My suggestion: 

* Maintain the fallback defaults somewhere safe, i.e. outside the config/ 
directory where no one will think to delete or edit them. 
* Leave config.yml.example where it is, as an example.
* Add a spec test that reads settings from the defaults, reads settings from 
config.yml.example, compares the two sets, and throws an error if they don't 
match. This will keep the two in sync. 


-- 
You have received this notification because you have either subscribed to it, 
or are involved in it.
To change your notification preferences, please click here: 
http://projects.puppetlabs.com/my/account

-- 
You received this message because you are subscribed to the Google Groups 
"Puppet Bugs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/puppet-bugs?hl=en.

Reply via email to