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

Add CI checks to ensure presets are sorted and no settings are missing #2038

Merged
merged 1 commit into from
Aug 13, 2023

Conversation

fenhl
Copy link
Collaborator

@fenhl fenhl commented Jul 10, 2023

Follow-up to #1861. Having presets_default.json in a normalized format like this will make it easier to diff, including across forks, and will ensure PRs of new settings will set appropriate values in Easy Mode and Hell Mode. I've filled in the settings that were missing with their defaults, except for a couple cases in Easy Mode and Hell Mode.

@fenhl fenhl added Component: Misc A catch-all label Component: Presets Settings and hints presets labels Jul 10, 2023
@cjohnson57
Copy link
Collaborator

Is this something that can be fixed automatically using the --fix flag?

@fenhl
Copy link
Collaborator Author

fenhl commented Jul 16, 2023

No, because I want --fix to be noninteractive and I think contributors adding new settings should consider what's appropriate for each preset (especially Easy Mode and Hell Mode) rather than just using the default everywhere.

@cjohnson57
Copy link
Collaborator

I don't see an error message for the settings being unsorted, it feels like it'd be hard for someone adding a preset to know what they did wrong and be able to fix it

@fenhl
Copy link
Collaborator Author

fenhl commented Jul 16, 2023

It currently just says “presets not formatted correctly”. I guess that check could be done twice, once before sorting the reference and again after sorting, with the second error message being “presets not sorted” and auto-fixable.

@cjohnson57
Copy link
Collaborator

Yeah, I just feel like putting the burden of sorting all of our 900 settings on the preset maker by themselves is a bit much

@cjohnson57 cjohnson57 merged commit dbd4c91 into OoTRandomizer:Dev Aug 13, 2023
3 checks passed
@fenhl fenhl deleted the ci-presets branch August 13, 2023 07:25
@fenhl fenhl added this to the 8.0 milestone Mar 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Misc A catch-all label Component: Presets Settings and hints presets
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants