Support reproducible builds by forcing window.search to use stable key ordering. #692
Conversation
This file contains 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
azerupi
approved these changes
May 13, 2018
|
The argument for adding this is sound. |
|
Sounds good to me 👍 |
This was referenced Oct 10, 2018
Ruin0x11
pushed a commit
to Ruin0x11/mdBook
that referenced
this pull request
Aug 30, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In CI, I run
mdbook buildto check that my repo's book is still well-formed. Each time I run this though, git notices thatsearchindex.jshas been modified, even when I haven't made any changes to the book.Running a diff on the old and new output shows that the only difference is in key ordering. Rust's HashMaps are randomly ordered,
elasticlunr-rsuses HashMaps internally and when usingserde_json::to_stringthat random order is directly written out.We can force reproducible output by using
serde_json::Valueas an intermediary output, which uses BTreeMap internally, and will order the output keys consistently when written to a JSON string.I can confirm that rerunning
mdbook buildrepeatedly in my repo does not causesearchindex.jsto be marked as modified.