8275745: Reproducible copyright headers #1498

ebourg · 2020-11-28T23:14:35Z

The copyright headers are generated at build time, and the year inserted in the template depends on the current date. This means the headers are not reproducible if the project is built a year later. The year in the headers could be derived from the SOURCE_DATE_EPOCH environment variable to make the build reproducible (this variable is already used in other parts of the build).

Progress

Change must not contain extraneous whitespace
Commit message must refer to an issue
Change must be properly reviewed

Issue

JDK-8275745: Reproducible copyright headers

Reviewers

Magnus Ihse Bursie (@magicus - Reviewer) ⚠️ Review applies to 9c4efbda20bbf8afbc6027356385c5aa4e5e7c80
Erik Joelsson (@erikj79 - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk pull/1498/head:pull/1498
$ git checkout pull/1498

Update a local copy of the PR:
$ git checkout pull/1498
$ git pull https://git.openjdk.java.net/jdk pull/1498/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 1498

View PR using the GUI difftool:
$ git pr show -t 1498

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk/pull/1498.diff

bridgekeeper · 2020-11-28T23:15:17Z

Hi @ebourg, welcome to this OpenJDK project and thanks for contributing!

We do not recognize you as Contributor and need to ensure you have signed the Oracle Contributor Agreement (OCA). If you have not signed the OCA, please follow the instructions. Please fill in your GitHub username in the "Username" field of the application. Once you have signed the OCA, please let us know by writing /signed in a comment in this pull request.

If you already are an OpenJDK Author, Committer or Reviewer, please click here to open a new issue so that we can record that fact. Please use "Add GitHub user ebourg" as summary for the issue.

If you are contributing this work on behalf of your employer and your employer has signed the OCA, please let us know by writing /covered in a comment in this pull request.

openjdk · 2020-11-28T23:16:14Z

@ebourg The following labels will be automatically applied to this pull request:

build
core-libs
i18n

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

ebourg · 2020-11-28T23:21:32Z

/signed

bridgekeeper · 2020-11-28T23:22:32Z

Thank you! Please allow for up to two weeks to process your OCA, although it is usually done within one to two business days. Also, please note that pull requests that are pending an OCA check will not usually be evaluated, so your patience is appreciated!

ebourg · 2020-11-28T23:32:29Z

/label remove core-libs,i18n

openjdk · 2020-11-28T23:32:44Z

@ebourg
The core-libs label was successfully removed.

The i18n label was successfully removed.

bridgekeeper · 2020-12-27T01:39:37Z

@ebourg This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply add a new comment to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

ebourg · 2020-12-27T14:36:19Z

Dummy comment to keep this issue alive (auto closing after 8 weeks of inactivity is a bad idea)

bridgekeeper · 2021-01-24T16:36:40Z

@ebourg This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply add a new comment to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

ebourg · 2021-02-01T14:49:36Z

.

bridgekeeper · 2021-03-01T16:06:13Z

@ebourg This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply add a new comment to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

ebourg · 2021-03-05T09:13:37Z

.

openjdk · 2021-03-17T09:49:53Z

@ebourg Unknown command signed - for a list of valid commands use /help.

y1yang0 · 2021-03-18T09:10:16Z

You should link an issue to this patch so that a Request-For-Review email will be sent to the corresponding mailing list. Or they may not notice your patch.

ebourg · 2021-03-18T13:46:35Z

Unfortunately I don't have a JBS account, so I'm stuck here bumping this PR every 4 weeks until someone notices it.

bridgekeeper · 2021-04-21T13:38:33Z

@ebourg This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply add a new comment to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

ebourg · 2021-04-21T14:13:56Z

.

y1yang0 · 2021-04-21T14:36:41Z

Hi Emmanuel Bourg,

I'm not quite sure whether this PR is useful since I'm not familiar with the make system. I think you can just send an email to build-dev@openjdk.java.net(You may need to subscribe it before), the related folks/experts would review your change or give some meaningful feedbacks if they think it's worth doing it. Good Luck!

Thanks,
Yang

ebourg · 2021-04-21T15:31:18Z

Yes, 5 months later I now understand that the GitHub issue tracker isn't the right entry point to contribute to OpenJDK, sadly.

bridgekeeper · 2021-05-19T16:27:27Z

@ebourg This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply add a new comment to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

ebourg · 2021-06-07T13:23:32Z

.

magicus · 2021-11-11T13:45:21Z

@ebourg I have now modified this patch so it uses COPYRIGHT_YEAR, and sets COPYRIGHT_YEAR based on SOURCE_DATE_EPOCH, if it exists. The patch is in a branch in my personal fork, https://github.com/magicus/jdk/tree/reproducible-copyright-year.

If you think it looks good, we have two possible ways forward. Either you close this PR, and I open a new targeting the same JBS issue, and credit you as co-author. Or you integrate my branch into this PR, and credit me as co-author. Any of them is OK for me, but I think the former is simpler.

ebourg · 2021-11-11T15:06:03Z

@magicus Thank you! I've integrated your branch

magicus

LGTM but then again I wrote most of it. :) Please await further reviewers before integrating.

openjdk · 2021-11-11T15:08:30Z

⚠️ @ebourg the full name on your profile does not match the author name in this pull requests' HEAD commit. If this pull request gets integrated then the author name from this pull requests' HEAD commit will be used for the resulting commit. If you wish to push a new commit with a different author name, then please run the following commands in a local repository of your personal fork:

$ git checkout reproducible-copyright-headers
$ git commit -c user.name='Preferred Full Name' --allow-empty -m 'Update full name'
$ git push

openjdk · 2021-11-11T15:08:31Z

@ebourg This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8275745: Reproducible copyright headers

Reviewed-by: ihse, erikj

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 634 new commits pushed to the master branch:

b15e6f0: 8277449: compiler/vectorapi/TestLongVectorNeg.java fails with release VMs
11d819d: 8277439: G1: Correct include guard name in G1EvacFailureObjectsSet.hpp
7a046e0: 8277371: Remove unnecessary DefNewGeneration::ref_processor_init()
3a76d39: 8277324: C2 compilation fails with "bad AD file" on x86-32 after JDK-8276162 due to missing match rule
2f20b0d: 8273039: JShell crashes when naming variable or method "abstract" or "strictfp"
f34f119: 8277213: CompileTask_lock is acquired out of order with MethodCompileQueue_lock
47564ca: 8275643: C2's unaryOp vector intrinsic does not properly handle LongVector.neg
2f0bde1: 8277102: Dubious PrintCompilation output
839033b: 8276976: Rename LIR_OprDesc to LIR_Opr
89b125f: 8275527: Refactor forward pointer access
... and 624 more: https://git.openjdk.java.net/jdk/compare/5e4b514e6e7e1b9f51fac1983b6c12a988f7f5a8...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@magicus, @erikj79) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

ebourg · 2021-11-11T15:12:21Z

I can rebase the branch with your changes only, my commit just adds noise.

magicus · 2021-11-11T20:19:25Z

In the future, please refrain from force pushing to a PR. It makes history hard to follow for reviewers, and is generally strongly discouraged. OpenJDK uses the Skara tools which will automatically squash and rebase the commits in the PR.

ebourg · 2021-11-11T21:34:58Z

Thank you for the advice, I'm not familiar with the Skara workflow yet.

magicus · 2021-11-19T12:30:41Z

@ebourg To finish integrating this PR, you need to type /integrate as a PR comment. This will allow the Skara bots to move the bug on to the state where I can sponsor it.

ebourg · 2021-11-19T13:14:17Z

/integrate

ebourg · 2021-11-19T13:14:56Z

@magicus Thank you for the hint!

openjdk · 2021-11-19T13:16:11Z

@ebourg
Your change (at version 618d28a) is now ready to be sponsored by a Committer.

magicus · 2021-11-19T13:53:06Z

/sponsor

openjdk · 2021-11-19T13:55:20Z

Going to push as commit a022796.
Since your change was applied there have been 636 commits pushed to the master branch:

b1a1bf4: 8277427: Update jib-profiles.js to use JMH 1.33 devkit
03debf2: 8276774: Cookie stored in CookieHandler not sent if user headers contain cookie
b15e6f0: 8277449: compiler/vectorapi/TestLongVectorNeg.java fails with release VMs
11d819d: 8277439: G1: Correct include guard name in G1EvacFailureObjectsSet.hpp
7a046e0: 8277371: Remove unnecessary DefNewGeneration::ref_processor_init()
3a76d39: 8277324: C2 compilation fails with "bad AD file" on x86-32 after JDK-8276162 due to missing match rule
2f20b0d: 8273039: JShell crashes when naming variable or method "abstract" or "strictfp"
f34f119: 8277213: CompileTask_lock is acquired out of order with MethodCompileQueue_lock
47564ca: 8275643: C2's unaryOp vector intrinsic does not properly handle LongVector.neg
2f0bde1: 8277102: Dubious PrintCompilation output
... and 626 more: https://git.openjdk.java.net/jdk/compare/5e4b514e6e7e1b9f51fac1983b6c12a988f7f5a8...master

Your commit was automatically rebased without conflicts.

openjdk · 2021-11-19T13:55:33Z

@magicus @ebourg Pushed as commit a022796.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

magicus · 2021-11-19T13:56:12Z

@ebourg Thank you for your contribution! It's been a long and bumpy ride for something that seemed like a simple patch. I hope you have not been scared away from contributing to the JDK in the future. :-)

ebourg · 2021-11-19T14:21:59Z

Thanks again for walking me through the process, I'll try to submit more reproducibility fixes, there are a few more patches pending in Debian:
https://salsa.debian.org/openjdk-team/openjdk/-/blob/openjdk-17/debian/patches/reproducible-build-jmod.diff
https://salsa.debian.org/openjdk-team/openjdk/-/blob/openjdk-17/debian/patches/reproducible-build-user.diff
https://salsa.debian.org/openjdk-team/openjdk/-/blob/openjdk-17/debian/patches/reproducible-character-data.diff
https://salsa.debian.org/openjdk-team/openjdk/-/blob/openjdk-17/debian/patches/reproducible-javadoc-timestamp.diff
https://salsa.debian.org/openjdk-team/openjdk/-/blob/openjdk-17/debian/patches/reproducible-module-info.diff
https://salsa.debian.org/openjdk-team/openjdk/-/blob/openjdk-17/debian/patches/reproducible-properties-timestamp.diff

magicus · 2021-11-20T21:40:55Z

@ebourg You might be interested in watching what @andrew-m-leonard is doing in the area, for example in #6395.

mlbridge · 2021-11-21T15:49:33Z

Mailing list message from Jonathan Gibbons on build-dev:

Emmanual,

If you're interested, please contact the javadoc-dev at openjdk.java.net
list regarding the javadoc fix. While the diff looks promising, it would
require a corresponding regression test.

-- Jon

On 11/19/21 6:24 AM, Emmanuel Bourg wrote:

On Thu, 11 Nov 2021 15:37:09 GMT, Emmanuel Bourg <duke at openjdk.java.net> wrote:

[snip]

https://salsa.debian.org/openjdk-team/openjdk/-/blob/openjdk-17/debian/patches/reproducible-javadoc-timestamp.diff

[snip]

bridgekeeper bot added the oca Needs verification of OCA signatory status label Nov 28, 2020

openjdk bot added build build-dev@openjdk.org core-libs core-libs-dev@openjdk.org i18n i18n-dev@openjdk.org labels Nov 28, 2020

bridgekeeper bot added the oca-verify Needs verification of OCA signatory status label Nov 28, 2020

openjdk bot removed core-libs core-libs-dev@openjdk.org i18n i18n-dev@openjdk.org labels Nov 28, 2020

bridgekeeper bot removed oca Needs verification of OCA signatory status oca-verify Needs verification of OCA signatory status labels Dec 9, 2020

magicus approved these changes Nov 11, 2021

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Nov 11, 2021

magicus added 2 commits November 11, 2021 16:33

Set COPYRIGHT_YEAR from SOURCE_DATE_EPOCH if present

a91f6ad

Make gensrc code use $COPYRIGHT_YEAR

618d28a

ebourg force-pushed the reproducible-copyright-headers branch from 9c4efbd to 618d28a Compare November 11, 2021 15:33

erikj79 approved these changes Nov 12, 2021

View reviewed changes

openjdk bot added the sponsor Pull request is ready to be sponsored label Nov 19, 2021

openjdk bot closed this Nov 19, 2021

openjdk bot added integrated Pull request has been integrated and removed ready Pull request is ready to be integrated rfr Pull request is ready for review sponsor Pull request is ready to be sponsored labels Nov 19, 2021

8275745: Reproducible copyright headers #1498

8275745: Reproducible copyright headers #1498

Conversation

ebourg commented Nov 28, 2020 • edited by openjdk bot

Progress

Issue

Reviewers

Reviewing

bridgekeeper bot commented Nov 28, 2020

openjdk bot commented Nov 28, 2020

ebourg commented Nov 28, 2020

bridgekeeper bot commented Nov 28, 2020

ebourg commented Nov 28, 2020

openjdk bot commented Nov 28, 2020

bridgekeeper bot commented Dec 27, 2020

ebourg commented Dec 27, 2020

bridgekeeper bot commented Jan 24, 2021

ebourg commented Feb 1, 2021

bridgekeeper bot commented Mar 1, 2021

ebourg commented Mar 5, 2021

openjdk bot commented Mar 17, 2021

y1yang0 commented Mar 18, 2021

ebourg commented Mar 18, 2021

bridgekeeper bot commented Apr 21, 2021

ebourg commented Apr 21, 2021

y1yang0 commented Apr 21, 2021

ebourg commented Apr 21, 2021

bridgekeeper bot commented May 19, 2021

ebourg commented Jun 7, 2021

magicus commented Nov 11, 2021

ebourg commented Nov 11, 2021

magicus left a comment

Choose a reason for hiding this comment

openjdk bot commented Nov 11, 2021

openjdk bot commented Nov 11, 2021 • edited

ebourg commented Nov 11, 2021

magicus commented Nov 11, 2021

ebourg commented Nov 11, 2021

magicus commented Nov 19, 2021

ebourg commented Nov 19, 2021

ebourg commented Nov 19, 2021

openjdk bot commented Nov 19, 2021

magicus commented Nov 19, 2021

openjdk bot commented Nov 19, 2021

openjdk bot commented Nov 19, 2021

magicus commented Nov 19, 2021

ebourg commented Nov 19, 2021

magicus commented Nov 20, 2021

mlbridge bot commented Nov 21, 2021

ebourg commented Nov 28, 2020 •

edited by openjdk bot

openjdk bot commented Nov 11, 2021 •

edited