[ 
https://issues.apache.org/jira/browse/RAT-171?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Philipp Ottlinger updated RAT-171:
----------------------------------
    Description: 
h3. Context

The apache-rat-plugin ignores by default the .gitignore files. However, for 
every file/pattern added to those files, an explicit exclusion must be set in 
the plugin's configuration.
 Given that git-ignored files won't be uploaded to the SCM and shouldn't be 
part of a release, it would be nice that the apache-rat-plugin automatically 
considered those git-ignored files as implicit exclusions.
h3. Implemented for

Currently implemented for the following soure code management systems:
 * SVN
 * Git
 * Bazaar
 * Mercurial and
 * CVS.

The solution just takes each line of the ignore file as an exclusion that is 
not a comment line.
 Thus no special logics for exclusions are parsed or different functionalities 
of a SCM taken into account.
 Each line is taken as it is and added to RAT's default exclusions.
h3. Example usage

You can configure parsing SCM ignore files by a environment variable
{code:java}
mvn -U -debug -Drat.parseSCMIgnoresAsExcludes=true
{code}
or in your configuration section of apache-rat-maven plugin
{code:java}
<parseSCMIgnoresAsExcludes>true</parseSCMIgnoresAsExcludes>
{code}
This features is enabled by default.

In case you want to speed up the build you may disable it and set it to
{code:java}
false
{code}
.

  was:
h3. Context
The apache-rat-plugin ignores by default the .gitignore files. However, for 
every file/pattern added to those files, an explicit exclusion must be set in 
the plugin's configuration.
Given that git-ignored files won't be uploaded to the SCM and shouldn't be part 
of a release, it would be nice that the apache-rat-plugin automatically 
considered those git-ignored files as implicit exclusions.

h3. Implemented for 
Currently implemented for the following soure code management systems:
* SVN
* Git
* Bazaar
* Mercurial and 
* CVS.

The solution just takes each line of the ignore file as an exclusion that is 
not a comment line.
Thus no special logics for exclusions are parsed or different functionalities 
of a SCM taken into account.
Each line is taken as it is and added to RAT's default exclusions.

h3. Example usage
You can configure parsing SCM ignore files by a environment variable 
{code}
mvn -U -debug -Drat.parseSCMIgnoresAsExcludes=true
{code}
or in your configuration section of apache-rat-maven plugin 
{code}
<parseSCMIgnoresAsExcludes>true</true>
{code}

This features is enabled by default.

In case you want to speed up the build you may disable it and set it to 
{code}
false
{code}
.


> Allow exclude patterns to be read from a file or files
> ------------------------------------------------------
>
>                 Key: RAT-171
>                 URL: https://issues.apache.org/jira/browse/RAT-171
>             Project: Apache Rat
>          Issue Type: New Feature
>    Affects Versions: 0.11
>            Reporter: Ignasi Barrera
>            Assignee: Philipp Ottlinger
>            Priority: Major
>             Fix For: 0.12
>
>         Attachments: RAT-171.patch
>
>
> h3. Context
> The apache-rat-plugin ignores by default the .gitignore files. However, for 
> every file/pattern added to those files, an explicit exclusion must be set in 
> the plugin's configuration.
>  Given that git-ignored files won't be uploaded to the SCM and shouldn't be 
> part of a release, it would be nice that the apache-rat-plugin automatically 
> considered those git-ignored files as implicit exclusions.
> h3. Implemented for
> Currently implemented for the following soure code management systems:
>  * SVN
>  * Git
>  * Bazaar
>  * Mercurial and
>  * CVS.
> The solution just takes each line of the ignore file as an exclusion that is 
> not a comment line.
>  Thus no special logics for exclusions are parsed or different 
> functionalities of a SCM taken into account.
>  Each line is taken as it is and added to RAT's default exclusions.
> h3. Example usage
> You can configure parsing SCM ignore files by a environment variable
> {code:java}
> mvn -U -debug -Drat.parseSCMIgnoresAsExcludes=true
> {code}
> or in your configuration section of apache-rat-maven plugin
> {code:java}
> <parseSCMIgnoresAsExcludes>true</parseSCMIgnoresAsExcludes>
> {code}
> This features is enabled by default.
> In case you want to speed up the build you may disable it and set it to
> {code:java}
> false
> {code}
> .



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Reply via email to