Versions Compared

Old Version 83

changes.mady.by.user Gale Naylor

Saved on

compared with

New Version 84

changes.mady.by.user Gale Naylor

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

4. Check the top-level LICENSE and NOTICE files

LICENSE file

Check the text of the LICENSE file in the top-level release candidate folder, and ensure the Apache License matches the text of the required Apache License. The LICENSE file may also include details of additional licenses.

If additional, third-party licenses are listed below the required Apache License, ensure the licenses are allowed in Apache Software Foundation projects. (See also item 9, Check the dependencies - Review binary licenses.)

NOTICE file

Check the text of the NOTICE file in the top-level release candidate folder, and ensure it matches the text below.

...

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 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.

...

Anchor
build
build
Build

8. Build the release candidate(s) from source

Run mvn clean install

  1. Successfully complete the verification steps above.
  2. Use a command line interface and navigate to the folder containing the unzipped release candidate files. 
  3. 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
after-the-build
after-the-build
AFTER the (successful) build

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.)

  1. In a command line interface, change to the top level directory of the distribution (e.g., apache-taverna-language-<version>-incubator).
  2. 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.)
  3. This command will create THIRD-PARTY.txt files in each target folder (in the generated-sources/license subfolder).
  4. 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?)

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

  • 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