New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc/conf.py: if set, use SOURCE_DATE_EPOCH to set copyright year. #20608
doc/conf.py: if set, use SOURCE_DATE_EPOCH to set copyright year. #20608
Conversation
The build date of the software shouldn't really have any bearing on the copyright dates, but by respecting SOURCE_DATE_EPOCH, it at least limits this to the last time something in the source was changed. https://reproducible-builds.org/specs/source-date-epoch/
|
originally reported as https://bugs.debian.org/990339 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for opening your first PR into Matplotlib!
If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.
You can also join us on gitter for real-time discussion.
For details on testing, writing docs, and our review process, please see the developer guide
We strive to be a welcoming and open project. Please follow our Code of Conduct.
|
Is this really an issue? Matplotlib source changes a lot more often than yearly. |
|
This needs to pass flake8 though. |
One problem is if you build a version from 2019 in 2021, without changing anything in the source code, the documentation will incorrectly claim copyright for the year it was built(2021), not when the source was written(2019). Another problem is if you build a version from 2019 in 2021, it will contain changes, even if you use the exact same toolchain for the two builds, so it is not bit-for-bit identical, requiring manual review of the differences rather than comparing for bit-for-bit identical files using a checksum. Hope that helps explain it better! |
|
flake8 issue should be fixed now. |
The build date of the software shouldn't really have any bearing on
the copyright dates, but by respecting SOURCE_DATE_EPOCH, it at least
limits this to the last time something in the source was changed.
https://reproducible-builds.org/specs/source-date-epoch/
PR Summary
PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsand runflake8 --docstring-convention=all).doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).