THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
Ready to be reviewed. Several questions (in light blue) need answers. Section 6, checking provenance, needs technical input.
Introduction
This document is intended for first-time reviewers of Apache Taverna, particularly those reviewers who desire additional information about the review process and tools used. It assumes you have already read How to Review a Release and Vote.
...
- Create a temporary directory for the release candidate.
- Open the VOTE email, and click the release candidate link. This will open a web page with four additional links: .zip (the release candidate),.asc (the signature file), .md5 (the md5 hash file), and .sha1 (the sha1 hash file). (See sections 1a and b 1b below for information about signature and hash files.)
- Download the files to your computer by clicking on each of the four links and saving the files to your computer. (You may need to use Ctrl-S to save a text file from the browser to text. Make sure the browser does not append ".txt" to the file.)
Alternatively, you can use wget to download the release candidate. (See Apache Stratos 3.0.0 Test Procedure.)
...
- The VOTE email,
- The release candidate .zip file, and
- The checksum files (.md5 and .sha1), downloaded at the same time as the release candidate.
(Is the intent to ensure the checksums from all 3 sources are identical?) All three checksums should be identical.
There are two steps: generate and verify. You can use a command line interface or a utility. Both methods are described below.
Check using the command line interface
GENERATE. To generate checksums, navigate to the directory containing the .zip file and run the CertUtil command. Append SHA512 and MD5, as shown below, to generate those checksums. (The default gives you the SHA1 checksum.)
...
VERIFY. To verify, visually compare the checksums with those listed in the VOTE email, or use an online difference checker.
Check using the MD5 and SHA Checksum Utility
GENERATE. Follow the steps below.
...
Each software artifact is signed using a PGP (Pretty Good Privacy) key. Verifying the downloaded key matches the original key is a critical step.
You can verify the signatures using a command line interface. See https://httpd.apache.org/dev/verification.html for some general verification info.
Command line interface
- Download the Taverna key file from https://dist.apache.org/repos/dist/release/incubator/taverna/KEYS. (On Windows this can be done by typing Ctrl-S in the browser window and saving the file as keys.txt.)
- Import the key file into GPG:
gpg --import keys.txt
- Download the .asc file. (Save this file in the same folder as keys.txt.)
- Verify the .asc file matches the zipped release candidate by using the gpg command with the --verify option followed by the .asc filename and the .zip filename.
...
The idea here is to check that the commit ID in the downloaded file matches that in the VOTE email. You will use a command line interface for at least some of these steps.
Approach 1 (clone the git repository, checkout the commit id, and compare to release candidate)
This approach uses Git commands to compare the downloaded release candidate to a cloned git repository. You will clone one copy and unzip the other copy in such a way that will "trick" Git into thinking you are comparing two versions that you have edited. (I'm missing part of the picture here. What is the end configuration you want before you use git status to compare files?)
- Make a new directory and change to that directory (eMake a new directory and change to that directory (e.g., mkdir 1 ; cd 1)
- Git clone that-repository (which repository?? from where??)
- Checkout the commit id from the repository you just created: git checkout <commit_id>
- rm -rf* (remove a directory? I don't understand this step.)
- Unzip the release candidate (e.g., apache-taverna-parent-2-incubating-source-release.zip) (into the same directory?)
- mv apache-taverna-"/*. (one level up) (Move the release candidate up one level? Because it zips into a new folder?)
- git status
Git will then review the checksums of every file and let you know what has "changed."
If there are NO CHANGES, then the commit ID in the VOTE email matches the release candidate.
Approach 2 (download git commit from GitHub and compare to release candidate)
This approach uses the commit id from the VOTE email to download that commit from GitHub, which is then compared to the release candidate using the diff command.
...
5. Check the source file headers
How does a reviewer know if a source file has been submitted directly to the ASF?
Code developed at the ASF
Check that each file has the ASF license header text and no copyright. The ASF Source Headers web page details how to handle source file headers for code developed at the ASF. In short, the copyright must be removed (see requirements) and files should have the ASF license header text added to the header.
Third-party files
Check that each file has a license (?) and and that the license is allowed. Files used by the project, but not submitted by their owners directly to the ASF, are treated differently. Copyright notices stay in the header, and associated licenses must be part of the distribution.
6. Check the provenance. Check the provenance
TO DOTO DO What exactly is this, how does it differ from licensing, and how do you accomplish it?
7. Check that the source code does not include any binaries
...
| Anchor | ||||
|---|---|---|---|---|
|
8. Build the release candidate(s) from source
Run mvn clean install
- Successfully complete the verification steps above.
- Use a command line interface and navigate to the folder containing the unzipped release candidate files.
- Execute the command below, which will build the release candidate and save the output to two text files. (The text file names can be anything.) This command will run several Maven goals, including automated tests. Do not skip the automated build tests.
mvn clean install > console.txt 2> err.txt
Review build completion status
BUILD FAILURE: At the completion of the mvn clean install process, if the message is "BUILD FAILURE," review both text files. Report the failure, along with any warning and error messages, on the release candidate's DISCUSS thread.
BUILD SUCCESS: If the completion message is "BUILD SUCCESS," review both text files. Report the success, along with any warning messages, on the release candidate's DISCUSS thread.
| Anchor | ||||
|---|---|---|---|---|
|
9. Check the dependencies
Checking dependencies:
- Make sure dependencies are used and declared properly. (Use mvn dependency:analyze and look for warnings or errors.)
- Determine if there are any mismatches between resolved dependencies and the dependencyManagement section. (Use mvn dependency:analyze-dep-mgt and look for warnings or errors.)
- Generate a list of licenses for each third-party dependency and check the licenses to make sure they meet Apache licensing requirements. (See Review Binary License below.)
- You can create a list of dependencies by module using mvn dependency:list and generate a dependency tree to troubleshoot conflicts using mvn dependency:tree.
Review Binary Licenses.
Create a list of third-party dependencies using the license:aggregate-add-third-party plugin and review the dependency licenses.)
- In a command line interface, change to the top level directory of the distribution (e.g., apache-taverna-language-<version>-incubator).
- Run the following Maven command: mvn license:aggregate-add-third-party. (On Windows, to save the output to a file, add > filename.txt to the end of the command.)
- This command will create THIRD-PARTY.txt files in each target folder (in the generated-sources/license subfolder).
- Review the THIRD-PARTY.txt files for unknown or disallowed licenses. Note: some unknown licenses have been determined to be allowed.) One method is shown below.
cat target/generated-sources/license/THIRD-PARTY.txt | sort
10. Verify the build produces the binaries
Quick check: browse the target folders and make sure there are not any extra folders. (For example, if we are voting on taverna-language there should not be any taverna-engine folders.)
Deeper check: ensure your target folders contains all the same *.jar files as those in the git repo? in the Maven repository? (Example link?)TBR.
At least one person should check that all staged JARs are the same as those built from the downloaded release candidate. (One approach is to do a recursive wget of the repository , and then compare the result of "find . -name '*jar'" in the wget-tree with */*/target/*.jar. See StackOverflow response.)
NOTE: Binary releases are considered "convenience only" and are not crucial for the vote: The source release is what everything else should be made from. However, in practical terms most people download the binaries from the Maven repository, so it is important this is checked at least once.
11. Verify all the *.jar files include the word "incubating"
Visually inspect all the *.jar files include the word "incubating" by opening all the /target folders. Is there an easier way to do this?Are other files supposed to be labeled as well, or is it only the *.jar files?
Anchor tips tips
Tips
| tips | |
| tips |
How to check LICENSE, NOTICE, DISCLAIMER, and similar files?
- Command line: Navigate to directory containing the file and use cat command to print contents to console (Example: cat LICENSE)
- Text Editor/IDE: Use a text editor (e.g., Notepad++) or an integrated development environment (IDE), such as Eclipse, to open the LICENSE, NOTICE, DISCLAIMER, and similar files.
How to capture the output of a command line interface command?
- In a command line interface, send the console output and error messages to a text file:
- GitBash example: mvn clean install > Console.txt 2> Err.txt
- In a command line interface, send the console output and error messages to a text file: