Uploaded image for project: 'Calcite'
  1. Calcite
  2. CALCITE-746

Allow apache-rat to be run outside of release process

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.8.0
    • Component/s: None
    • Labels:
      None

      Description

      In http://mail-archives.apache.org/mod_mbox/incubator-general/201505.mbox/%3C55654545.4090202%40apache.org%3E Brane wrote:

       RAT emits warnings:
      
      Files with unapproved licenses:
      
        ./git.properties
        ./avatica/src/main/resources/META-INF/services/java.sql.Driver
        ./core/src/main/resources/META-INF/services/java.sql.Driver
        ./example/csv/src/test/resources/bug/DATE.csv
        ./example/csv/src/test/resources/bug/WACKY_COLUMN_NAMES.csv
        ./example/csv/src/test/resources/bug/archers.json
        ./example/csv/src/test/resources/sales/DEPTS.csv
      
      *****************************************************
      Archives:
       + ./example/csv/src/test/resources/sales/EMPS.csv.gz
      
      These are clearly false positives, and I see that the pom.xml file
      contains exclusions for these files. I suggest also providing a
      rat-excludes file with the same exclusion rules, so that RAT can be run
      on the tree without going through maven (and trusting the pom.xml :).
      

        Issue Links

          Activity

          Hide
          julianhyde Julian Hyde added a comment -

          I investigated this. RAT's maven plugin cannot read an exclusions file (see RAT-161). So we'd have to maintain the list of exclusions in two places – in the pom.xml, and in .rat-excludes.

          Maintaining the data in two places seems to me to increase the chance of error.

          See also SPARK-1493. (The Spark team don't use maven, so I suppose that they run Rat by hand.)

          Show
          julianhyde Julian Hyde added a comment - I investigated this. RAT's maven plugin cannot read an exclusions file (see RAT-161 ). So we'd have to maintain the list of exclusions in two places – in the pom.xml, and in .rat-excludes. Maintaining the data in two places seems to me to increase the chance of error. See also SPARK-1493 . (The Spark team don't use maven, so I suppose that they run Rat by hand.)
          Hide
          julianhyde Julian Hyde added a comment -

          Add an exclusion for git.properties so that it succeeds on a source tarball.

          Move the config from the apache-release profile build to the build section. Then people will pick up the exclusions if they run mvn apache-rat:check or mvn verify and don't remember to specify -Papache-release.

          With these changes RAT can at least be run from inside maven, but insider or outside of the release process, which I think is good enough.

          Show
          julianhyde Julian Hyde added a comment - Add an exclusion for git.properties so that it succeeds on a source tarball. Move the config from the apache-release profile build to the build section. Then people will pick up the exclusions if they run mvn apache-rat:check or mvn verify and don't remember to specify -Papache-release . With these changes RAT can at least be run from inside maven, but insider or outside of the release process, which I think is good enough.
          Hide
          julianhyde Julian Hyde added a comment -

          Josh Elser notes:

          site/.sass_cache seems to have crept back into this release. Not a blocker IMO, but maybe a sign that we need to do something in the release process to try to catch this (here and for Avatica)

          I think adding sass_cache to .gitignore and removing it from the rat-exclusions will solve this.

          Show
          julianhyde Julian Hyde added a comment - Josh Elser notes: site/.sass_cache seems to have crept back into this release. Not a blocker IMO, but maybe a sign that we need to do something in the release process to try to catch this (here and for Avatica) I think adding sass_cache to .gitignore and removing it from the rat-exclusions will solve this.
          Show
          julianhyde Julian Hyde added a comment - Fixed in http://git-wip-us.apache.org/repos/asf/calcite/commit/4b93fa82 .
          Hide
          julianhyde Julian Hyde added a comment -

          Resolved in release 1.8.0 (2016-06-13).

          Show
          julianhyde Julian Hyde added a comment - Resolved in release 1.8.0 (2016-06-13).

            People

            • Assignee:
              julianhyde Julian Hyde
              Reporter:
              julianhyde Julian Hyde
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development