changes:github-text-list

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

Full name:

org.apache.maven.plugins:maven-changes-plugin:2.12.6:github-text-list

Description:

Mojo to format a list of issues from github in a text format. It will generate a apt or markdown text formatting style which can be set to a property. That property can then be inserted in another markdown or apt text file.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 2.12.3.

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.12.3 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.
failOnError boolean 2.12.3 Mojo failure in case of exception when getting no issues for supplied arguments. If false only a warning will be logged.
Default value is: true.
User property is: github.failOnError.
githubAPIPort int 2.12.3 The port of your github api domain. Only use if using github enterprise.
Default value is: 80.
githubAPIScheme String 2.12.3 The scheme of your github api domain. Only use if using github enterprise.
Default value is: http.
githubAPIServerId String 2.12.3 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.12.3 Boolean which says if we should include open issues in the report.
Default value is: true.
issueListPropertyName String 2.12.3 The name of the property to be set with the formatted result of issues, following the format defined at textListFormater.
Default value is: issues.text.list.
User property is: changes.issue.list.propert.name.
onlyCurrentVersion boolean 2.12.3 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, if removeSnapshotSuffix is set to true.
Default value is: false.
onlyMilestoneIssues boolean 2.12.3 Boolean which says if we should include only issues with milestones.
Default value is: true.
outputDirectory File 2.12.3 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.
personalToken String 2.12.3 Github personal token. If informed, it will take precedence for user and password associated with serverId which will be ignored.
User property is: changes.personalToken.
removeSnapshotSuffix boolean 2.12.3 If "-SNAPSHOT" suffix should be removed when searching for issues.
Default value is: true.
User property is: changes.removeSnapshotSuffix.
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.
subtitleLevelNumber int 2.12.3 The number of symbols used for sub-title leveling in case of version title separators. In case of markdown the number of '#' characters used in the version sub-title.
Default value is: 3.
User property is: subtitle.level.number.
textListFormater String 2.12.3 The text formatter to be used to format issues. Accepted values are apt or markdown.
Default value is: markdown.
User property is: changes.text.list.formater.

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.12.3
  • Required: No
  • Default: Id,Type,Summary,Assignee,Reporter,Status,Created,Updated,Fix Version

failOnError:

Mojo failure in case of exception when getting no issues for supplied arguments. If false only a warning will be logged.
  • Type: boolean
  • Since: 2.12.3
  • Required: No
  • User Property: github.failOnError
  • Default: true

githubAPIPort:

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

githubAPIScheme:

The scheme of your github api domain. Only use if using github enterprise.
  • Type: java.lang.String
  • Since: 2.12.3
  • 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.12.3
  • Required: No
  • Default: github

includeOpenIssues:

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

issueListPropertyName:

The name of the property to be set with the formatted result of issues, following the format defined at textListFormater.
  • Type: java.lang.String
  • Since: 2.12.3
  • Required: No
  • User Property: changes.issue.list.propert.name
  • Default: issues.text.list

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, if removeSnapshotSuffix is set to true.
  • Type: boolean
  • Since: 2.12.3
  • Required: No
  • Default: false

onlyMilestoneIssues:

Boolean which says if we should include only issues with milestones.
  • Type: boolean
  • Since: 2.12.3
  • 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.12.3
  • 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}

personalToken:

Github personal token. If informed, it will take precedence for user and password associated with serverId which will be ignored.
  • Type: java.lang.String
  • Since: 2.12.3
  • Required: No
  • User Property: changes.personalToken

removeSnapshotSuffix:

If "-SNAPSHOT" suffix should be removed when searching for issues.
  • Type: boolean
  • Since: 2.12.3
  • Required: No
  • User Property: changes.removeSnapshotSuffix
  • Default: true

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

subtitleLevelNumber:

The number of symbols used for sub-title leveling in case of version title separators. In case of markdown the number of '#' characters used in the version sub-title.
  • Type: int
  • Since: 2.12.3
  • Required: No
  • User Property: subtitle.level.number
  • Default: 3

textListFormater:

The text formatter to be used to format issues. Accepted values are apt or markdown.
  • Type: java.lang.String
  • Since: 2.12.3
  • Required: No
  • User Property: changes.text.list.formater
  • Default: markdown