GH-3091: Add verification guide and .rat-excludes.txt for release #3101
Conversation
| @@ -498,6 +498,7 @@ | |||
| <consoleOutput>true</consoleOutput> | |||
| <excludes> | |||
There was a problem hiding this comment.
I am pretty sure we can change excludes for excludesFile (https://creadur.apache.org/rat/apache-rat-plugin/rat-mojo.html#excludesFile) but I am unsure why some of the regex on the individual excludes don't seem to work with excludesFile when I ran:
java -jar apache-rat-0.16.1/apache-rat-0.16.1.jar -a -d apache-parquet-1.15.0.tar.gz -E $PARQUET_SRC_FOLDER/.rat-excludes.txt
I'll investigate how to consolidate those two lists
| @@ -91,3 +91,61 @@ Merge hash: 485658a5 | |||
| Would you like to pick 485658a5 into another branch? (y/n): | |||
| ``` | |||
| For now just say n as we have 1 branch | |||
|
|
|||
| # Release Verification | |||
There was a problem hiding this comment.
Thanks for adding this! Is it better to add this to the parquet site: https://github.com/apache/parquet-site/blob/production/content/en/docs/Contribution%20Guidelines/releasing.md?
There was a problem hiding this comment.
I agree the "release verification" should be moved to the parquet-site repo instead. Then, we even can have a link to this section in the VOTE email template.
I'm not sure why we need to check for the license headers separately in the tarball. It is already in the build process so we shall not have license header issues in the repo. What I usually do instead is comparing the content of the tarball with a freshly cloned repo set to the release RC tag. There should be no differences.
There was a problem hiding this comment.
I'm not sure why we need to check for the license headers separately in the tarball. It is already in the build process so we shall not have license header issues in the repo.
I see, we can probably remove explicitly checking license headers. This is something that in general I've seen all projects do as part of their release verification process and something that I would say falls under the "verify that they meet all requirements of ASF policy on releases as described below" point on the ASF release guide. But it is true that as soon as there hasn't been any change as those are already done feels unnecessary.
How do you perform the comparison between the content of the tarball with a freshly cloned repo set to the release RC tag? Do we want to add that as a step?
I will move the PR to the parquet-site one, I might take a couple of days as I am slightly busy at the moment.
There was a problem hiding this comment.
How do you perform the comparison between the content of the tarball with a freshly cloned repo set to the release RC tag? Do we want to add that as a step?
I use meld as diff tool but I don't think it should be added. Probably GNU diff can be configured to work on directory trees.
I will move the PR to the parquet-site one, I might take a couple of days as I am slightly busy at the moment.
I don't think we need to hurry. Please refer the parquet-site PR here so anyone call follow up.
Thanks a lot for working on this!
There was a problem hiding this comment.
I agree that the parquet-site is more suitable for these steps.
Regarding the license headers. It is part of the verification; having the rat check is just one way. All code must have an ASv2 license header. It would also be good to do manual checks when a new version is being released, as the RAT check might also miss something.
Thanks for working on this, this is really great 🙌
Rationale for this change
There is currently no guide on how to verify. Having a guider will encourage people to verify the release.
This guide should be linked on the Voting thread.
What changes are included in this PR?
Added documentation about how to verify and add
.rat-excludes.txtfile with the files that do not contain a current license but we are fine with those. Those files are mainly testing.avsc,.parquet,.gitignoreandPULL_REQUEST_TEMPLATE.mdfiles.Are these changes tested?
I've validated all steps localy
Are there any user-facing changes?
No, just more docs.
Closes #3091