accumulo-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sean Busbey (JIRA)" <>
Subject [jira] [Updated] (ACCUMULO-2986) Ease interaction with rat plugin for new users
Date Thu, 10 Jul 2014 09:28:05 GMT


Sean Busbey updated ACCUMULO-2986:

    Status: Patch Available  (was: Open)

Additional changes after changes in code review

h2. changes to jenkins

update [Accumulo 1.6|] and [Accumulo Master|]
builds so their maven goals and options become
    clean verify -DskipITs -Drat.ignoreErrors=false

h2. change to

In the section for "Reviewing contributor changes" the steps for patches should have the following
inserted between the existing steps 4 and 5.

5. Make sure the change does not introduce any license violations or regressions. At a minimum,
you should check compliance via the apache rat plugin and unit tests.
  mvn -Drat.ignoreErrors=false package
Additionally, you could run a small subset of the integration tests.
  mvn -Drat.ignoreErrors=false -Psunny verify

h2. change to

The "running a build" sub-section under "Building" should be truncated started at the "If
you regularly switch between major development branches"

A new section should be added between "Code Review" and "IDE Configuration Tips":

h3. License Verification

By default, builds will invoke the RAT plugin to check proper licensing is in place. If there
is a problem, the build should indicate warning similar to the following:

[INFO] --- apache-rat-plugin:0.10:check (check-licenses) @ accumulo-project ---
[INFO] 69 implicit excludes (use -debug for more details).
[INFO] No excludes explicitly specified.
[INFO] 292 resources included (use -debug for more details)
[INFO] Rat check: Summary of files. Unapproved: 12 unknown: 12 generated: 0 approved: 16 licence.
[WARNING] Rat check: 12 files with unapproved licenses. See RAT report in: /Users/busbey/projects/accumulo/target/rat.txt

For details on the source of the warning, look at the "rat.txt" file in the Maven build directory.

Optionally, contributors can invoke maven with an option to fail the build if there are licensing
problems. Committers should use the same system variable to check contributions prior to pushing
them into the repository.

  $> mvn -Drat.ignoreErrors=false package

Contributors can add the following profile to their Maven settings.xml file to perform this
enforcement in all builds.
Committers are strongly encouraged to use this profile as a part of their project responsibilities.


The text about changing branches and cleaning from the "running a build" subsection should
be inserted at the end of this new section.

> Ease interaction with rat plugin for new users
> ----------------------------------------------
>                 Key: ACCUMULO-2986
>                 URL:
>             Project: Accumulo
>          Issue Type: Improvement
>          Components: build
>    Affects Versions: 1.6.0
>            Reporter: Sean Busbey
>            Assignee: Sean Busbey
>            Priority: Minor
>             Fix For: 1.6.1, 1.7.0
> Per the [thread on our use of the rat plugin to validate licenses|],
ease the impact of rat on new contributors but make sure we can enforce things early and often.
> * move plugin to profile (default to active)
> * set ignoreErrors to true
> * make sure jenkins can fail the build for rat violations
> * update docs on handling contributions to check for rat violations
> * provide instructions for committers to make their builds always fail for rat violations

This message was sent by Atlassian JIRA

View raw message