Fix: Ensure deterministic file ordering in iter_package_files
#269
Conversation
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
### Summary Fixed non-deterministic file ordering in the `iter_package_files` function by adding explicit sorting of package files. This change ensures consistent behavior across builds and prevents issues caused by unordered file iteration. ### Changes Made - Applied `sorted()` to file listings in both Python versions (<3.11 and >=3.11). - Guaranteed that files are processed in a consistent, lexicographic order. ### Why This Fix? - Prevents non-deterministic builds caused by unordered file iteration. - Improves build reproducibility and enables better caching in CI/CD pipelines. - Simplifies code by enforcing consistent ordering within the function, reducing the need for manual sorting in callers. ### Testing - Rebuilt the project multiple times and verified that output files are now consistent across builds. - Compared generated artifacts (e.g., `.json` files) to confirm deterministic ordering. ### Impact - No functional changes to how files are processed, only improves determinism. - Safer and more reliable builds, especially in CI environments. Closes linkedin#265
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.
cc @lorencarvalho
Summary
Fixed non-deterministic file ordering in the
iter_package_filesfunction by adding explicit sorting of package files. This change ensures consistent behavior across builds and prevents issues caused by unordered file iteration.Changes Made
sorted()to file listings in both Python versions (<3.11 and >=3.11).Why This Fix?
Testing
.jsonfiles) to confirm deterministic ordering.Impact
Closes #265