changes:github-report

Note:This goal should be used as a Maven report.

Full name:

org.apache.maven.plugins:maven-changes-plugin:2.12:github-report

Description:

Goal which downloads issues from GitHub and generates a report.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 2.8.

Required Parameters

Name Type Since Description
basedir String 2.10 The current project base directory.
User property is: basedir.

Optional Parameters

Name Type Since Description
columnNames String 2.8 Sets the column names that you want to show in the report. The columns will appear in the report in the same order as you specify them here. Multiple values can be separated by commas.

Valid columns are: Assignee, Created, Fix Version, Id, Reporter, Status, Summary, Type and Updated.


Default value is: Id,Type,Summary,Assignee,Reporter,Status,Created,Updated,Fix Version.
githubAPIPort int 2.8 The port of your github api domain. Only use if using github enterprise.
Default value is: 80.
githubAPIScheme String 2.8 The scheme of your github api domain. Only use if using github enterprise.
Default value is: http.
githubAPIServerId String 2.8 The settings.xml server id to be used to authenticate into github api domain. Only use if using github enterprise.
Default value is: github.
includeOpenIssues boolean 2.8 Boolean which says if we should include open issues in the report.
Default value is: true.
onlyCurrentVersion boolean 2.8 If you only want to show issues for the current version in the report. The current version being used is ${project.version} minus any "-SNAPSHOT" suffix.
Default value is: false.
onlyMilestoneIssues boolean 2.8 Boolean which says if we should include only issues with milestones.
Default value is: true.
outputDirectory File 2.8 Report output directory. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.
Default value is: ${project.reporting.outputDirectory}.
outputEncoding String 2.4 Report output encoding. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output encoding configured in the Maven Site Plugin is used instead.
Default value is: ${project.reporting.outputEncoding}.
User property is: outputEncoding.
runOnlyAtExecutionRoot boolean 2.10 This will cause the execution to be run only at the top of a given module tree. That is, run in the project contained in the same folder where the mvn execution was launched.
Default value is: false.
User property is: changes.runOnlyAtExecutionRoot.

Parameter Details

basedir:

The current project base directory.
  • Type: java.lang.String
  • Since: 2.10
  • Required: Yes
  • User Property: basedir

columnNames:

Sets the column names that you want to show in the report. The columns will appear in the report in the same order as you specify them here. Multiple values can be separated by commas.

Valid columns are: Assignee, Created, Fix Version, Id, Reporter, Status, Summary, Type and Updated.

  • Type: java.lang.String
  • Since: 2.8
  • Required: No
  • Default: Id,Type,Summary,Assignee,Reporter,Status,Created,Updated,Fix Version

githubAPIPort:

The port of your github api domain. Only use if using github enterprise.
  • Type: int
  • Since: 2.8
  • Required: No
  • Default: 80

githubAPIScheme:

The scheme of your github api domain. Only use if using github enterprise.
  • Type: java.lang.String
  • Since: 2.8
  • Required: No
  • Default: http

githubAPIServerId:

The settings.xml server id to be used to authenticate into github api domain. Only use if using github enterprise.
  • Type: java.lang.String
  • Since: 2.8
  • Required: No
  • Default: github

includeOpenIssues:

Boolean which says if we should include open issues in the report.
  • Type: boolean
  • Since: 2.8
  • Required: No
  • Default: true

onlyCurrentVersion:

If you only want to show issues for the current version in the report. The current version being used is ${project.version} minus any "-SNAPSHOT" suffix.
  • Type: boolean
  • Since: 2.8
  • Required: No
  • Default: false

onlyMilestoneIssues:

Boolean which says if we should include only issues with milestones.
  • Type: boolean
  • Since: 2.8
  • Required: No
  • Default: true

outputDirectory:

Report output directory. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.
  • Type: java.io.File
  • Since: 2.8
  • Required: No
  • Default: ${project.reporting.outputDirectory}

outputEncoding:

Report output encoding. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output encoding configured in the Maven Site Plugin is used instead.
  • Type: java.lang.String
  • Since: 2.4
  • Required: No
  • User Property: outputEncoding
  • Default: ${project.reporting.outputEncoding}

runOnlyAtExecutionRoot:

This will cause the execution to be run only at the top of a given module tree. That is, run in the project contained in the same folder where the mvn execution was launched.
  • Type: boolean
  • Since: 2.10
  • Required: No
  • User Property: changes.runOnlyAtExecutionRoot
  • Default: false