gitlab:generate-changes

Full name:

io.ultreia.maven:gitlab-maven-plugin:1.0.20:generate-changes

Description:

Generate a changes.xml file with releases data used by maven-changes-plugin to generate project releases history report.

Created by tchemit on 20/02/17.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Binds by default to the lifecycle phase: pre-site.
  • Invokes the execution of this plugin's goal download-milestones prior to executing itself.

Required Parameters

Name Type Since Description
<basedir> String - The current project base directory.
User property is: basedir.
<cacheExtraPath> File - To add extra definition in cache (could be milestones, or artifacts).

Will be added to the gitlab cache.


Default value is: src/gitlab.
User property is: gitlab.cacheExtraPath.
<cachePath> File - (no description)
Default value is: ${project.build.directory}/gitlab-cache.
User property is: gitlab.cachePath.
<changesAuthor> String - (no description)
User property is: gitlab.changesAuthor.
<changesAuthorEmail> String - (no description)
User property is: gitlab.changesAuthorEmail.
<changesFile> File - (no description)
Default value is: ${project.basedir}/src/changes/changes.xml.
User property is: gitlab.changesFile.
<changesTitle> String - (no description)
User property is: gitlab.changesTitle.
<host> String - (no description)
User property is: gitlab.host.
<milestone> String - (no description)
Default value is: ${project.version}.
User property is: gitlab.milestone.
<organizationId> String - (no description)
User property is: gitlab.organizationId.
<projectId> String - (no description)
User property is: gitlab.projectId.
<serverId> String - (no description)
User property is: gitlab.serverId.
<trackers> String - Comma separated tracker names (they are gitlab label) and they match the type of issues used by the changes.xml format fix, add, update, remove in this precise order.

Note: order matter


User property is: gitlab.trackers.

Optional Parameters

Name Type Since Description
<quiet> boolean - (no description)
Default value is: false.
User property is: gitlab.quiet.
<runOnlyAtExecutionRoot> boolean - 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: true.
User property is: gitlab.runOnlyAtExecutionRoot.
<skip> boolean - (no description)
User property is: gitlab.skip.

Parameter Details

<basedir>

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

<cacheExtraPath>

To add extra definition in cache (could be milestones, or artifacts).

Will be added to the gitlab cache.

  • Type: java.io.File
  • Required: Yes
  • User Property: gitlab.cacheExtraPath
  • Default: src/gitlab

<cachePath>

(no description)
  • Type: java.io.File
  • Required: Yes
  • User Property: gitlab.cachePath
  • Default: ${project.build.directory}/gitlab-cache

<changesAuthor>

(no description)
  • Type: java.lang.String
  • Required: Yes
  • User Property: gitlab.changesAuthor

<changesAuthorEmail>

(no description)
  • Type: java.lang.String
  • Required: Yes
  • User Property: gitlab.changesAuthorEmail

<changesFile>

(no description)
  • Type: java.io.File
  • Required: Yes
  • User Property: gitlab.changesFile
  • Default: ${project.basedir}/src/changes/changes.xml

<changesTitle>

(no description)
  • Type: java.lang.String
  • Required: Yes
  • User Property: gitlab.changesTitle

<host>

(no description)
  • Type: java.lang.String
  • Required: Yes
  • User Property: gitlab.host

<milestone>

(no description)
  • Type: java.lang.String
  • Required: Yes
  • User Property: gitlab.milestone
  • Default: ${project.version}

<organizationId>

(no description)
  • Type: java.lang.String
  • Required: Yes
  • User Property: gitlab.organizationId

<projectId>

(no description)
  • Type: java.lang.String
  • Required: Yes
  • User Property: gitlab.projectId

<quiet>

(no description)
  • Type: boolean
  • Required: No
  • User Property: gitlab.quiet
  • Default: false

<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
  • Required: No
  • User Property: gitlab.runOnlyAtExecutionRoot
  • Default: true

<serverId>

(no description)
  • Type: java.lang.String
  • Required: Yes
  • User Property: gitlab.serverId

<skip>

(no description)
  • Type: boolean
  • Required: No
  • User Property: gitlab.skip

<trackers>

Comma separated tracker names (they are gitlab label) and they match the type of issues used by the changes.xml format fix, add, update, remove in this precise order.

Note: order matter

  • Type: java.lang.String
  • Required: Yes
  • User Property: gitlab.trackers