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

settings: read from config.toml #1439

Merged
merged 3 commits into from
Jan 12, 2024
Merged

settings: read from config.toml #1439

merged 3 commits into from
Jan 12, 2024

Conversation

jdx
Copy link
Owner

@jdx jdx commented Jan 11, 2024

Fixes #1436

Moving to settings.toml was a regretful mistake. It turns out that having 2 config files in a CLI is just a bad idea. It's confusing to users and ultimately wasn't even necessary so we're going back to 1 file.

Sorry for the musical chairs here. I know breaking changes like that are not great and especially when they get reverted it would be especially maddening. Moving back, however, should not be a breaking change.

We've taken steps to correct this from a project management perspective by setting up an advisory board: https://mise.jdx.dev/team.html You can certainly expect fewer abrupt changes in the future. A group of people able to review decisions like this before I roll out a change is exactly what this project needed.

We've gone through this together and came up with a plan to get us off of having settings.toml and back to config.toml in a way that should involve minimal disruption—in fact I think it's possible nobody may even notice this change.

This change should not negatively impact anyone. mise will read from both files and merge the contents, preferring config.toml. You can continue to use settings.toml and not change a thing. In a few weeks, I'm going to roll out another change to silently merge the contents of settings.toml into config.toml. If you'd like to stay ahead of that, go ahead and put the contents of settings.toml back into config.toml like before and nothing will change for you.

I really am sorry for this one. I should've been a lot more careful rolling out the initial change to split these files up. Just know that we've definitely taken some steps to correct that.

@jdx
Copy link
Owner Author

jdx commented Jan 11, 2024

In case anyone is curious, I really don't think it would've made sense to "live with this decision" and stick to 2 config files in mise. I think that would've caused a ton of confusion for all of the future users of mise that pales in comparison to the short-term pain of moving away from this mistake now.

jdx added a commit that referenced this pull request Jan 11, 2024
@jdx jdx marked this pull request as ready for review January 12, 2024 20:55
@jdx jdx enabled auto-merge (squash) January 12, 2024 20:56
@jdx jdx merged commit cdfda7d into main Jan 12, 2024
9 checks passed
@jdx jdx deleted the settings branch January 12, 2024 21:01
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.

deleting a setting attempts to remove it from config.toml instead of settings.toml
1 participant