Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Complain when users specify old config values. #307

Merged
merged 2 commits into from Apr 27, 2016

Conversation

ralphbean
Copy link
Sponsor Collaborator

In 81e8d74, we accidentally changed the config value from
only_if_assigned to $SERVICE.only_if_assigned. That's okay by me,
just because it makes things consistent. But, it breaks people's existing
configs (it broke mine).

This change adds some warnings which will halt bugwarrior and prompt you to
update your config.

In 81e8d74, we accidentally changed the config value from
``only_if_assigned`` to ``$SERVICE.only_if_assigned``.  That's okay by
me, just because it makes things consistent.  But, it breaks people's
existing configs (it broke mine).

This change adds some warnings which will halt bugwarrior and prompt you
to update your config.
@ryneeverett
Copy link
Collaborator

That's okay by me, just because it makes things consistent.

Isn't the current consistency that Common Service Configuration Options do not have the $SERVICE.<option> scheme?

If we wanted to eliminate this distinction, I would think we'd want to go in the opposite direction -- removing the $SERVICE. part -- because it's a lot of text in the config file not adding any information since it's already specified by the service setting. But I don't feel strongly about that.

@coddingtonbear
Copy link
Collaborator

The $SERVICE.<option> format is my fault, and you can feel free to remove it if you so desire, but I do personally find it useful given that INI files have special behavior w/r/t how the section named [DEFAULT] works.

@ryneeverett
Copy link
Collaborator

From a quick search, my understanding is that if a key isn't found in a given section, it will fall back to the one found in [DEFAULT].

If that is correct, then I agree that putting service-specific values in their own namespace makes sense. We don't want to make falling back to a nonsensical default value a possibility. Because nobody reuses their usernames and passwords, right? Err, bad example.

And since only_if_assigned takes a username, it is also service-specific and belongs in the $SERVICE namespace. But the other "Common Service Configuration Options" are not service-specific and should remain as they are.

Does that make sense?

@coddingtonbear
Copy link
Collaborator

Ahh, sure, that does make sense!

@ryneeverett
Copy link
Collaborator

Cool. LGTM.

@ralphbean
Copy link
Sponsor Collaborator Author

OK. Will merge this soon.

@ralphbean ralphbean merged commit 9a31af4 into develop Apr 27, 2016
@ralphbean ralphbean deleted the feature/include-bugfixes branch April 27, 2016 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants