stat-scm:stats

Generate a Source Code Management Metrics Report.

Mojo Attributes:

  • Requires a Maven 2.0 project to execute.
  • Automatically executes within the lifecycle phase: site

Optional Parameters

Name Type Description
cacheDir String Specify a cache directory for information retrieved from the Subversion server (e.g. line counts). The data will be saved in this directory. The directory will be created if it doesn't exist. By default, the current user directory is used. This is only relevant when the SCM is subversion and is ignored if it is CVS.
excludes String[] Each <exclude> tag inside here gives one Ant-style wildcard pattern indicating what to exclude. Example: "** /test/*.java" matches all java files in with a 'test' folder somewhere in the path. Note that "*.java" only matches java files in the root directory, because '*' does not match subdirectories. (Quotes not needed.)



If not specified, no files will be excluded.



First we add in all files or all these files and then we subtract all the excluded files.
includes String[] Each <include> tag inside here gives one Ant-style wildcard pattern indicating what to include. Example: "src / ** / *.java" matches all java files in the src directory or its subdirectories. Note that "*.java "only matches java files in the root directory, because '*' does not match subdirectories. (Quotes not needed.)



If not specified, all files will be included.



First we add in all files or all these files and then we subtract all the excluded files.
nonDeveloperLogins String[] Each <nonDeveloperLogin> tag in inside here gives one scm login account name. Each account name given here will be excluded from all developer reports. This is useful to reduce noise from administrative and other non-developer accounts.



Multiple accounts can be excluded by adding a tag for each such account.
notesFile String The contents of the specified file will be included at the top of the report's index page. The file should contain a valid block-level HTML fragment, for example:

<p>
These are development statistics for the
<a href="http://www.statsvn.org">StatSVN</a>
project, created by StatSVN itself.
</p>
<p>
<strong>Note:</strong>
This report was generated by an unreleased
development version of StatSVN. It might
contain features not yet found in the
official release.
</p>
skip boolean Set this true to avoid running the stat-scm report in this project. Useful in child projects where the parent pom project specifies the stat-scm report.
title String Specifies a display title to be used in the reports. The setting in <project><name> is used if no title is specified here and the name of the Subversion module will be used as default if no title is otherwise specified.

Parameter Details

cacheDir

Specify a cache directory for information retrieved from the Subversion server (e.g. line counts). The data will be saved in this directory. The directory will be created if it doesn't exist. By default, the current user directory is used. This is only relevant when the SCM is subversion and is ignored if it is CVS.

  • Type: java.lang.String
  • Required: No

excludes Each <exclude> tag inside here gives one Ant-style wildcard pattern indicating what to exclude. Example: "** /test/*.java" matches all java files in with a 'test' folder somewhere in the path. Note that "*.java" only matches java files in the root directory, because '*' does not match subdirectories. (Quotes not needed.)



If not specified, no files will be excluded.



First we add in all files or all these files and then we subtract all the excluded files.
  • Type: java.lang.String[]
  • Required: No

includes Each <include> tag inside here gives one Ant-style wildcard pattern indicating what to include. Example: "src / ** / *.java" matches all java files in the src directory or its subdirectories. Note that "*.java "only matches java files in the root directory, because '*' does not match subdirectories. (Quotes not needed.)



If not specified, all files will be included.



First we add in all files or all these files and then we subtract all the excluded files.
  • Type: java.lang.String[]
  • Required: No

nonDeveloperLogins Each <nonDeveloperLogin> tag in inside here gives one scm login account name. Each account name given here will be excluded from all developer reports. This is useful to reduce noise from administrative and other non-developer accounts.



Multiple accounts can be excluded by adding a tag for each such account.
  • Type: java.lang.String[]
  • Required: No

notesFile The contents of the specified file will be included at the top of the report's index page. The file should contain a valid block-level HTML fragment, for example:

<p>
These are development statistics for the
<a href="http://www.statsvn.org">StatSVN</a>
project, created by StatSVN itself.
</p>
<p>
<strong>Note:</strong>
This report was generated by an unreleased
development version of StatSVN. It might
contain features not yet found in the
official release.
</p>
  • Type: java.lang.String
  • Required: No

skip Set this true to avoid running the stat-scm report in this project. Useful in child projects where the parent pom project specifies the stat-scm report.
  • Type: boolean
  • Required: No
  • Expression: false

title Specifies a display title to be used in the reports. The setting in <project><name> is used if no title is specified here and the name of the Subversion module will be used as default if no title is otherwise specified.
  • Type: java.lang.String
  • Required: No