ci: add JSON key sorting tool and CI check for reference files#1886
Merged
benflexcompute merged 2 commits intomainfrom Mar 11, 2026
Merged
ci: add JSON key sorting tool and CI check for reference files#1886benflexcompute merged 2 commits intomainfrom
benflexcompute merged 2 commits intomainfrom
Conversation
Add tools/sort_ref_json.py that recursively sorts keys in all test JSON files for deterministic ordering, making PR diffs easier to review. Add a standalone json-key-order job to the codestyle CI workflow. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Align v1 params_base.to_json output with the sorted ref files to fix 5 failing file_compare tests. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add tools/sort_ref_json.py that recursively sorts keys in all test JSON files for deterministic ordering, making PR diffs easier to review. Add a standalone json-key-order job to the codestyle CI workflow.
Note
Low Risk
Low risk: changes are limited to deterministic JSON serialization and a new CI check; main impact is on reference file diffs and any tooling/tests that depend on exact JSON formatting.
Overview
Adds a
json-key-orderjob tocodestyle.ymlthat runstools/sort_ref_json.py --checkto enforce deterministic key ordering for JSON reference files in CI.Updates JSON serialization in
Flow360BaseModel.to_jsonto write sorted keys (and a trailing newline), and re-formats the existingtests/data/**/simulation.jsonfixtures accordingly to reflect the canonical ordering.Written by Cursor Bugbot for commit 70939fd. This will update automatically on new commits. Configure here.