tycho-version-bump:update-target

Full name:

org.eclipse.tycho.extras:tycho-version-bump-plugin:4.0.11:update-target

Description:

This allows to update a target file to use newer version of specified items, e.g. IUs from updatesites or maven coordinates. In the simplest form this is called like

mvn -f [path to target project] tycho-version-bump:update-target

For updating maven target locations the mojo supports Version number comparison rule-sets similar to the Versions Maven Plugin please check the documentation there for further information about ruleset files.

For updating installable unit locations (also known as update sites) you can configure different strategies (see getUpdateSiteDiscovery()) to discover updates.

Attributes:

Requires a Maven project to be executed.
The goal is not marked as thread-safe and thus does not support parallel builds.

Optional Parameters

Name	Type	Since	Description
`<allowIncrementalUpdates>`	`boolean`	`-`	Whether to allow the incremental version number to be changed. Default: `true` User Property: `allowIncrementalUpdates`
`<allowMajorUpdates>`	`boolean`	`-`	Whether to allow the major version number to be changed. Default: `true` User Property: `allowMajorUpdates`
`<allowMinorUpdates>`	`boolean`	`-`	Whether to allow the minor version number to be changed. Default: `true` User Property: `allowMinorUpdates`
`<allowSubIncrementalUpdates>`	`boolean`	`-`	Whether to allow the subIncremental version number to be changed. Default: `true` User Property: `allowSubIncrementalUpdates`
`<mavenIgnoredVersions>`	`Set<String>`	`-`	Allows specifying ignored maven artifact versions as an alternative to providing a mavenRuleSet parameter. User Property: `maven.version.ignore`
`<mavenRuleSet>`	`RuleSet`	`-`	Allows specifying a org.codehaus.mojo.versions.model.RuleSet object describing rules on maven artifact versions to ignore when considering updates.
`<mavenRulesUri>`	`String`	`-`	URI of a ruleSet file containing the rules that control how to compare version numbers. User Property: `maven.version.rules`
`<project>`	`MavenProject`	`-`	No description. User Property: `project`
`<reportFileName>`	`File`	`-`	No description. Default: `${project.build.directory}/targetUpdates.md` User Property: `tycho.updatetarget.report`
`<reportPreamble>`	`String`	`-`	No description. Default: `Please review the changes and merge if appropriate, or cherry pick individual updates.` User Property: `tycho.updatetarget.report.preamble`
`<targetFile>`	`File`	`-`	Specify the path to the target file to update, if not given the current project settings will be used to find a suitable file User Property: `target`
`<updateEmptyVersion>`	`boolean`	`-`	If enabled, missing or empty versions are updated to the most recent found in the repository to guarantee a stable build Default: `true` User Property: `tycho.updatetarget.updateEmptyVersion`
`<updateSiteDiscovery>`	`List<String>`	`-`	A list of update site discovery strategies, the following is currently supported: `parent` - search the parent path for a composite that can be used to find newer versions `versionPattern[:pattern]` - specifies a pattern to match in the URL (defaults to `(\d+)\.(\d+)` where it increments each numeric part beginning at the last group, if no repository is found using the next group setting the previous to zero. Any non numeric pattern will be replaced by the empty string `datePattern[:pattern:format[:period]]` - specifies a pattern and format to match in the URL (defaults to `(\d{4}-\d{2}):yyyy-MM`) where the pattern defines a date that should be incremented by a given `java.time.Period` (defaults to `P3M7D`) If used on the CLI, individual values must be separated by a comma see here User Property: `discovery`

Parameter Details

<allowIncrementalUpdates>

Whether to allow the incremental version number to be changed.

Type: boolean
Required: No
User Property: allowIncrementalUpdates
Default: true

<allowMajorUpdates>

Whether to allow the major version number to be changed.

Type: boolean
Required: No
User Property: allowMajorUpdates
Default: true

<allowMinorUpdates>

Whether to allow the minor version number to be changed.

Type: boolean
Required: No
User Property: allowMinorUpdates
Default: true

<allowSubIncrementalUpdates>

Whether to allow the subIncremental version number to be changed.

Type: boolean
Required: No
User Property: allowSubIncrementalUpdates
Default: true

<mavenIgnoredVersions>

Allows specifying ignored maven artifact versions as an alternative to providing a mavenRuleSet parameter.

Type: java.util.Set<java.lang.String>
Required: No
User Property: maven.version.ignore

<mavenRuleSet>

Allows specifying a org.codehaus.mojo.versions.model.RuleSet object describing rules on maven artifact versions to ignore when considering updates.

Type: org.codehaus.mojo.versions.model.RuleSet
Required: No

<mavenRulesUri>

URI of a ruleSet file containing the rules that control how to compare version numbers.

Type: java.lang.String
Required: No
User Property: maven.version.rules

<project>

No description.

Type: org.apache.maven.project.MavenProject
Required: No
User Property: project

<reportFileName>

No description.

Type: java.io.File
Required: No
User Property: tycho.updatetarget.report
Default: ${project.build.directory}/targetUpdates.md

<reportPreamble>

No description.

Type: java.lang.String
Required: No
User Property: tycho.updatetarget.report.preamble
Default: Please review the changes and merge if appropriate, or cherry pick individual updates.

<targetFile>

Specify the path to the target file to update, if not given the current project settings will be used to find a suitable file

Type: java.io.File
Required: No
User Property: target

<updateEmptyVersion>

If enabled, missing or empty versions are updated to the most recent found in the repository to guarantee a stable build

Type: boolean
Required: No
User Property: tycho.updatetarget.updateEmptyVersion
Default: true

<updateSiteDiscovery>

A list of update site discovery strategies, the following is currently supported:

parent - search the parent path for a composite that can be used to find newer versions
versionPattern[:pattern] - specifies a pattern to match in the URL (defaults to (\d+)\.(\d+) where it increments each numeric part beginning at the last group, if no repository is found using the next group setting the previous to zero. Any non numeric pattern will be replaced by the empty string
datePattern[:pattern:format[:period]] - specifies a pattern and format to match in the URL (defaults to (\d{4}-\d{2}):yyyy-MM)

java.time.Period

P3M7D

If used on the CLI, individual values must be separated by a comma see here

Type: java.util.List<java.lang.String>
Required: No
User Property: discovery