bugzilla:sync

Full name:

de.smartics.maven.plugin:bugzilla-maven-plugin:0.7.0:sync

Description:

Used after a release: Updates a product on the issue management server with information from this project and initializes the version information for that project.

Attributes:

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

Required Parameters

Name Type Since Description
settingsSecurityLocation String 1.0 The location of the settings-security.xml.

Optional Parameters

Name Type Since Description
addDefaultComponentsForMultiModuleProjects boolean 1.0 Signals to add the default component descriptions for multi module projects. The default descriptions are added in addition to the names of the sub modules. This has no effect on single modules where the default component descriptions are always added.
Default value is: false.
configurationName String 1.0 The name of the resource on the class path that contains the configuration. The XML file must conform to http://www.smartics.de/schema/bugzilla-configuration/1".
Default value is: bugzilla-configuration-default.xml.
defaultMilestone String 1.0 The default milestone to use. Defaults to the current version without -SNAPSHOT suffix.
extension String 1.0 The extension to use for querying the Nexus server for the latest released version, if releasedVersion is set to NEXUS. Per default the extension will be derived from the POM's packaging information.
initialOwner String 1.0 The name of the initial owner of issues for the components. Currently the initial owner for each component is the same.
initialVersion String 1.0 The initial version to use.
Default value is: ${project.Version}.
issueServerId String 1.0 The name of the server configuration in the settings.xml that provides credentials to access the issues server. Only used if no server matches the POM's issueManagement/url and issueManagement/system.
Default value is: bugzilla.
issueServerVersion String 1.0 The version of the issue server. Allows the implementation to make version dependent decisions.
locale String 1.0 The locale to use to select default component descriptions. If a not supported locale is used, it defaults to the given default. If specified, the configurationName is adjusted by adding this locale (e.g. bugzilla-configuration-default-en.xml).
Default value is: en.
nexusServer String 1.0 If releasedVersion is set to NEXUS and the default searching for the release repository's HTTP URL ending with / or /nexus would not determine the correct URL, override it here. This value will take precedence.
oldProduct String 1.0 The old name to select the product on the server. Differs only from product if the name has changed.
Default value is: ${project.artifactId}.
product String 1.0 The name of product.
Default value is: ${project.artifactId}.
releasedVersion String 1.0 The released version to add. Also the major, minor and micro increment milestones are added. If for e.g. the released version is 1.2.3, this version and the milestones 1.2.4, 1.3.0 and 2.0.0 are initialized.

If the released version cannot be recognized by Maven's standard implementation of a version parser, increment versions will not be added.

It is allowed to use the tokens MICRO, MINOR, MAJOR to let the plugin calculate the previous version by the current version in the POM. For instance:

  • 1.2.3-SNAPSHOT MICRO -> 1.2.2
  • 1.2.0-SNAPSHOT MINOR -> 1.1.0
  • 1.2.1-SNAPSHOT MINOR -> 1.2.0
  • 2.0.0-SNAPSHOT MAJOR -> 1.0.0
  • 2.0.1-SNAPSHOT MAJOR -> 2.0.0

The following example contexts raise an exception:

  • 1.2.0-SNAPSHOT MICRO -> Failure
  • 1.0.0-SNAPSHOT MINOR -> Failure
  • 0.0.0-SNAPSHOT MAJOR -> Failure
  • 0.1.2-SNAPSHOT MAJOR -> Failure

If the version is not provided, the nexus server will be queried for the released version.


Default value is: NEXUS.
repositoryId String 1.0 The repository ID to use to query the Nexus server for the latest released version, if releasedVersion is set to NEXUS. Per default the plugin will use the identifier of the release repository found in the distributionManagement. This value overrides the default behavior.
skipProductUpdate boolean 1.0 If set to true the Bugzilla product will not be updated. Usually there are no changes to the components, so that skipping is the default.
Default value is: true.
suppressSubModuleNamesAsComponents boolean 1.0 Signals that in the case of a multi module project the sub module names should not be added as components. Note: If you do not set 'addDefaultComponentsForMultiModuleProjects' to 'true' the product will be added without any components.
Default value is: false.
verbose String 1.0 Defines the verboseness of the output.
  • QUIET - prints no info messages.
  • NORMAL - only prints the returned page titles.
  • VERBOSE - adds information about the called service and parameters.
  • TRACE - provides the most verbose output with dumping the contents of the returned pages.

Default value is: NORMAL.

Parameter Details

addDefaultComponentsForMultiModuleProjects:

Signals to add the default component descriptions for multi module projects. The default descriptions are added in addition to the names of the sub modules. This has no effect on single modules where the default component descriptions are always added.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false

configurationName:

The name of the resource on the class path that contains the configuration. The XML file must conform to http://www.smartics.de/schema/bugzilla-configuration/1".
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Default: bugzilla-configuration-default.xml

defaultMilestone:

The default milestone to use. Defaults to the current version without -SNAPSHOT suffix.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${defaultMilestone}

extension:

The extension to use for querying the Nexus server for the latest released version, if releasedVersion is set to NEXUS. Per default the extension will be derived from the POM's packaging information.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No

initialOwner:

The name of the initial owner of issues for the components. Currently the initial owner for each component is the same.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${initialOwner}

initialVersion:

The initial version to use.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${initialVersion}
  • Default: ${project.Version}

issueServerId:

The name of the server configuration in the settings.xml that provides credentials to access the issues server. Only used if no server matches the POM's issueManagement/url and issueManagement/system.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Default: bugzilla

issueServerVersion:

The version of the issue server. Allows the implementation to make version dependent decisions.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${issueServerVersion}

locale:

The locale to use to select default component descriptions. If a not supported locale is used, it defaults to the given default. If specified, the configurationName is adjusted by adding this locale (e.g. bugzilla-configuration-default-en.xml).
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Default: en

nexusServer:

If releasedVersion is set to NEXUS and the default searching for the release repository's HTTP URL ending with / or /nexus would not determine the correct URL, override it here. This value will take precedence.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${nexusServer}

oldProduct:

The old name to select the product on the server. Differs only from product if the name has changed.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${oldProduct}
  • Default: ${project.artifactId}

product:

The name of product.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${product}
  • Default: ${project.artifactId}

releasedVersion:

The released version to add. Also the major, minor and micro increment milestones are added. If for e.g. the released version is 1.2.3, this version and the milestones 1.2.4, 1.3.0 and 2.0.0 are initialized.

If the released version cannot be recognized by Maven's standard implementation of a version parser, increment versions will not be added.

It is allowed to use the tokens MICRO, MINOR, MAJOR to let the plugin calculate the previous version by the current version in the POM. For instance:

  • 1.2.3-SNAPSHOT MICRO -> 1.2.2
  • 1.2.0-SNAPSHOT MINOR -> 1.1.0
  • 1.2.1-SNAPSHOT MINOR -> 1.2.0
  • 2.0.0-SNAPSHOT MAJOR -> 1.0.0
  • 2.0.1-SNAPSHOT MAJOR -> 2.0.0

The following example contexts raise an exception:

  • 1.2.0-SNAPSHOT MICRO -> Failure
  • 1.0.0-SNAPSHOT MINOR -> Failure
  • 0.0.0-SNAPSHOT MAJOR -> Failure
  • 0.1.2-SNAPSHOT MAJOR -> Failure

If the version is not provided, the nexus server will be queried for the released version.

  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${releasedVersion}
  • Default: NEXUS

repositoryId:

The repository ID to use to query the Nexus server for the latest released version, if releasedVersion is set to NEXUS. Per default the plugin will use the identifier of the release repository found in the distributionManagement. This value overrides the default behavior.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${repositoryId}

settingsSecurityLocation:

The location of the settings-security.xml.
  • Type: java.lang.String
  • Since: 1.0
  • Required: Yes
  • Expression: ${user.home}/.m2/settings-security.xml

skipProductUpdate:

If set to true the Bugzilla product will not be updated. Usually there are no changes to the components, so that skipping is the default.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Expression: ${skipProductUpdate}
  • Default: true

suppressSubModuleNamesAsComponents:

Signals that in the case of a multi module project the sub module names should not be added as components. Note: If you do not set 'addDefaultComponentsForMultiModuleProjects' to 'true' the product will be added without any components.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false

verbose:

Defines the verboseness of the output.
  • QUIET - prints no info messages.
  • NORMAL - only prints the returned page titles.
  • VERBOSE - adds information about the called service and parameters.
  • TRACE - provides the most verbose output with dumping the contents of the returned pages.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${verbose}
  • Default: NORMAL