Do not store current timestamps in gz headers #569
Merged
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
to enable reproducible builds of rdoc Normally, 0 would be the preferred value to indicate "no date" but that value is handled differently in Zlib::GzipWriter to put in the current time
aycabta
suggested changes
Jan 6, 2018
lib/rdoc/generator/json_index.rb
Outdated
| @@ -175,7 +175,7 @@ def generate_gzipped | |||
| debug_msg "Writing gzipped search index to %s" % outfile | |||
|
|
|||
| Zlib::GzipWriter.open(outfile) do |gz| | |||
| gz.mtime = File.mtime(search_index_file) | |||
| gz.mtime = 1 # make output reproducible | |||
There was a problem hiding this comment.
I think the mtime should be updated because the search_index.js.gz is generated dynamically. Please use SOURCE_DATE_EPOCH after RDoc::Generator::JsonIndex#generate creates index file.
lib/rdoc/generator/json_index.rb
Outdated
| @@ -193,7 +193,7 @@ def generate_gzipped | |||
| debug_msg "Writing gzipped file to %s" % outfile | |||
|
|
|||
| Zlib::GzipWriter.open(outfile) do |gz| | |||
| gz.mtime = File.mtime(dest) | |||
| gz.mtime = 1 # make output reproducible | |||
There was a problem hiding this comment.
Please fix FileUtils.install in RDoc::Generator::JsonIndex#generate with :preserve option instead of this because the mtime value is based on original .js file.
For your information, FileUtils.install is based on "install(1)" command.
The mtime for search_index.js.gz should be updated because it's generated dynamically. So uses SOURCE_DATE_EPOCH after RDoc::Generator::JsonIndex#generate creates index file. FileUtils.install in RDoc::Generator::JsonIndex#generate with :preserve option because the mtime value is based on original .js file.
aycabta
approved these changes
Jan 27, 2018
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.
to enable reproducible builds of rdoc
Normally, 0 would be the preferred value to indicate "no date"
but that value is handled differently in Zlib::GzipWriter
to put in the current time