DOC: make the documentation reproducible when rebuilt #652
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
The Reproducible Builds project aims to arrange for rebuilding the same source code in a sufficiently similar environment to produce the same installable packages every time, as a way to discourage supply-chain attacks by making it possible to verify that a particular installable package was built from the claimed source code. Previously, if meson-python was built twice, at least a year apart, then its documentation would contain different copyright dates. The SOURCE_DATE_EPOCH environment variable is used here to avoid that difference: the intention is that environments that want to produce reproducible packages will set SOURCE_DATE_EPOCH to some suitable fixed date (perhaps the date of the most recent git commit) which is held constant across rebuilds. See the specification for SOURCE_DATE_EPOCH for more details: https://reproducible-builds.org/docs/source-date-epoch/ [smcv: Added commit message] Co-authored-by: Simon McVittie <[email protected]>
|
Thanks for forwarding this upstream, @smcv ! |
|
I hope you're sufficiently happy with the long commit message that I added. I didn't want to leave it at just what you said in the original patch, because as an upstream developer (in other projects, not this one), if I received a similar patch without having the context of knowing about the reproducible builds goal within Debian, I would have wanted to see more details in the commit message before accepting it. |
|
Oh, very happy. In fact, I may use this as a template to improve my own PRs. Thanks :) |
rgommers
changed the title
Merged
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.
From: @lamby
Make the documentation reproducible when rebuilt
The Reproducible Builds project aims to arrange for rebuilding the same
source code in a sufficiently similar environment to produce the same
installable packages every time, as a way to discourage supply-chain
attacks by making it possible to verify that a particular installable
package was built from the claimed source code.
Previously, if meson-python was built twice, at least a year apart,
then its documentation would contain different copyright dates. The
SOURCE_DATE_EPOCH environment variable is used here to avoid that
difference: the intention is that environments that want to produce
reproducible packages will set SOURCE_DATE_EPOCH to some suitable fixed
date (perhaps the date of the most recent git commit) which is held
constant across rebuilds.
See the specification for SOURCE_DATE_EPOCH for more details:
https://reproducible-builds.org/docs/source-date-epoch/
[smcv: Added commit message]
Co-authored-by: @smcv
The actual change here is a patch originally sent to https://bugs.debian.org/1076806.