From e7353107d7ee874cb1a24e6e1044eaa866507efd Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 14 Jun 2024 00:51:38 +0200 Subject: [PATCH] Bump org.codehaus.mojo:mojo-parent from 80 to 82 (#1078) * Bump org.codehaus.mojo:mojo-parent from 80 to 82 Bumps [org.codehaus.mojo:mojo-parent](https://github.com/mojohaus/mojo-parent) from 80 to 82. - [Release notes](https://github.com/mojohaus/mojo-parent/releases) - [Commits](https://github.com/mojohaus/mojo-parent/commits) --- updated-dependencies: - dependency-name: org.codehaus.mojo:mojo-parent dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] * format --------- Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Sylwester Lachiewicz --- README.md | 12 +- ReleaseNotes.md | 171 +++++++++--------- pom.xml | 2 +- .../markdown/examples/compare-dependencies.md | 8 +- .../examples/display-dependency-updates.md | 2 +- .../examples/display-plugin-updates.md | 5 +- .../examples/display-property-updates.md | 3 +- .../site/markdown/examples/lock-snapshots.md | 9 +- .../markdown/examples/recording-changes.md | 2 +- .../site/markdown/examples/resolve-ranges.md | 11 +- .../src/site/markdown/examples/set.md | 5 +- .../site/markdown/examples/setaggregator.md | 5 +- .../markdown/examples/unlock-snapshots.md | 5 +- .../markdown/examples/update-child-modules.md | 6 +- .../site/markdown/examples/update-parent.md | 5 +- .../site/markdown/examples/use-releases.md | 5 +- .../src/site/markdown/faq.md | 10 +- .../src/site/markdown/index.md | 70 +++---- .../src/site/markdown/xsd/index.md | 1 - versions-model/src/site/markdown/xsd/index.md | 2 +- 20 files changed, 172 insertions(+), 167 deletions(-) diff --git a/README.md b/README.md index 273d759562..93b5d63836 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # MojoHaus Versions Maven Plugin This is the [versions-maven-plugin](http://www.mojohaus.org/versions-maven-plugin/). - + [![Apache License, Version 2.0, January 2004](https://img.shields.io/github/license/mojohaus/versions-maven-plugin.svg?label=License)](http://www.apache.org/licenses/) [![Maven Central](https://img.shields.io/maven-central/v/org.codehaus.mojo/versions-maven-plugin.svg?label=Maven%20Central)](https://search.maven.org/artifact/org.codehaus.mojo/versions-maven-plugin) [![Build Status](https://github.com/mojohaus/versions-maven-plugin/workflows/GitHub%20CI/badge.svg?branch=master)](https://github.com/mojohaus/versions-maven-plugin/actions/workflows/maven.yml?query=branch%3Amaster) @@ -12,7 +12,7 @@ Versions Maven Plugin requires Maven 3.2.5+ and JDK 1.8+ However, we maintain the latest Plugin version with the latest Maven. -We execute tests against different operating systems and JDKs +We execute tests against different operating systems and JDKs by [GitHub Actions](https://github.com/mojohaus/versions-maven-plugin/actions/workflows/maven.yml?query=branch%3Amaster) ## Contributing @@ -31,14 +31,14 @@ and describe what is going wrong or what you expect to happen. If you have a full working example or a log file this is also helpful. -You should of course describe only a single issue in a single ticket and not +You should of course describe only a single issue in a single ticket and not mixing up several things into a single issue. Please always check your issue with the latest Plugin and tha latest Maven version. ### Creating a Pull Request -Before you start working on more complicated change, new feature +Before you start working on more complicated change, new feature it is good practice to create an issue in the [ticket system](https://github.com/mojohaus/versions-maven-plugin/issues) or send an emil to [development list](https://www.mojohaus.org/versions-maven-plugin/mailing-lists.html) @@ -47,7 +47,7 @@ Wait a few days for feedback from other contributors. Afterwards you can create an appropriate pull request. It is required if you want to get a pull request to be integrated into please -squash your commits into a single commit which references the optional issue +squash your commits into a single commit which references the optional issue in the commit message which looks like this: ``` @@ -56,7 +56,7 @@ Fixed #Issue - change subject a description ``` -Please take consider that change subject will be used in release notes +Please take consider that change subject will be used in release notes and will be present in git history so should be enough descriptive. This makes it simpler to merge it and this will also close the diff --git a/ReleaseNotes.md b/ReleaseNotes.md index 8134287409..560371d0ab 100644 --- a/ReleaseNotes.md +++ b/ReleaseNotes.md @@ -2,134 +2,131 @@ ## 2.6 - * [Pull Request #252][pull-252] +* [Pull Request #252][pull-252] - Thanks to Edward Maxwell-Lyte <2248005+edwardmlyte@users.noreply.github.com> + Thanks to Edward Maxwell-Lyte <2248005+edwardmlyte@users.noreply.github.com> - Minor spelling corrections + Minor spelling corrections - * [Fixed Issue 157][issue-157] +* [Fixed Issue 157][issue-157] - Document the end of versioning limitations in Maven 3.x - There may remain good reasons for defining custom versioning rules to - let versions-maven-plugin apply, but at least not the old Maven 2.x - limitation + Document the end of versioning limitations in Maven 3.x + There may remain good reasons for defining custom versioning rules to + let versions-maven-plugin apply, but at least not the old Maven 2.x + limitation - * [Fixed Issue 256][issue-256] +* [Fixed Issue 256][issue-256] - if initial and new version are equals, just display initial - this means this is a plugin version that requires a Maven version that - is not compatible with project minimum version, not really a proposed - upgrade + if initial and new version are equals, just display initial + this means this is a plugin version that requires a Maven version that + is not compatible with project minimum version, not really a proposed + upgrade - * [Fixed Issue 237][issue-237] +* [Fixed Issue 237][issue-237] - Thanks to Julian Di Leonardo + Thanks to Julian Di Leonardo - Adding parent processing to UseLatestVersion/UseLatestSnapshot/UseLatestRelease + Adding parent processing to UseLatestVersion/UseLatestSnapshot/UseLatestRelease - * [Fixed Issue 190][issue-190] +* [Fixed Issue 190][issue-190] - Thanks to Julian Di Leonardo + Thanks to Julian Di Leonardo - Fixing issue in update-child-modules, where root module's version was - being used in all downstream children even when a child's parent was - different. - - * [Fixed Issue 219][issue-219] - - Added threadSafe=true to goals to prevent - warning in Maven builds if you start Maven - via: mvn -T .. + Fixing issue in update-child-modules, where root module's version was + being used in all downstream children even when a child's parent was + different. - * [Fixed Issue 215][issue-215] +* [Fixed Issue 219][issue-219] + + Added threadSafe=true to goals to prevent + warning in Maven builds if you start Maven + via: mvn -T .. + +* [Fixed Issue 215][issue-215] ## 2.5 +* [Fixed Issue 202][issue-202] + + -DprocessParent=true is ignored by user-reactor mojo. + +* [Fixed Issue 182][issue-182] + + Add goal for updating the SCM tag in the POM. + +* [Fixed Issue 197][issue-197] + + Java 1.7 as prerequisite. + +* [Fixed Issue 198][issue-198] - * [Fixed Issue 202][issue-202] + Update version of modules which are not children but part of reactor. - -DprocessParent=true is ignored by user-reactor mojo. +* [Fixed Issue 185][issue-185] - * [Fixed Issue 182][issue-182] + Unable to set dependencyReportFormat as parameter anymore. + Thanks to Ilja Dubinin. - Add goal for updating the SCM tag in the POM. +* [Fixed Issue 187][issue-187] - * [Fixed Issue 197][issue-197] + create target directory when run dependency update report. + Thanks to Ilja Dubinin. - Java 1.7 as prerequisite. +* [Pull Request #189][pull-189] - * [Fixed Issue 198][issue-198] + Fixed inccorect links. Thanks to Anton Johansson. - Update version of modules which are not children but part of reactor. +* [Fixed Issue 177][issue-177] - * [Fixed Issue 185][issue-185] + A required class was missing while executing on dependency-updates-report - Unable to set dependencyReportFormat as parameter anymore. - Thanks to Ilja Dubinin. +* [Fixed Issue 129][issue-129] - * [Fixed Issue 187][issue-187] + dependency-update-report now is able to disable the processing + of the transitive dependencies in the dependencyManagement part. + This can be enabled (default)/disabled by setting + processDependencyManagementTransitive accordingly. - create target directory when run dependency update report. - Thanks to Ilja Dubinin. +* [Fixed Issue 166][issue-166] - * [Pull Request #189][pull-189] + Upgraded modello-maven-plugin to 1.9.1 - Fixed inccorect links. Thanks to Anton Johansson. +* [Fixed Issue 167][issue-167] - * [Fixed Issue 177][issue-177] - - A required class was missing while executing on dependency-updates-report - - * [Fixed Issue 129][issue-129] - - dependency-update-report now is able to disable the processing - of the transitive dependencies in the dependencyManagement part. - This can be enabled (default)/disabled by setting - processDependencyManagementTransitive accordingly. + Upgraded versions-maven-plugin from 2.1 to 2.4 - * [Fixed Issue 166][issue-166] - - Upgraded modello-maven-plugin to 1.9.1 +* [Fixed Issue 168][issue-168] - * [Fixed Issue 167][issue-167] - - Upgraded versions-maven-plugin from 2.1 to 2.4 + Added allowMajorUpdates, allowMinorUpdates, allowIncrementalUpdates + to resolve-ranges and display-property-updates goal. - * [Fixed Issue 168][issue-168] - - Added allowMajorUpdates, allowMinorUpdates, allowIncrementalUpdates - to resolve-ranges and display-property-updates goal. +* [Fixed Issue 37][issue-37] - * [Fixed Issue 37][issue-37] - - Enhanced documentation for aggegator modules. - - * [Fixed Issue 46][issue-46] - - Added processDependencyManagement option to control the reporting - of dependencyManagement. - Thanks to Bruce Brouwer. + Enhanced documentation for aggegator modules. - * [Fixed Issue 94][issue-94] - - introduced allowMajorUpdates, allowMinorUpdates, - allowIncrementalUpdates. - introduced allowAnyUpdates for compatibility which - will be removed in 3.0.0 of the plugin. +* [Fixed Issue 46][issue-46] - * [Fixed Issue 34][issue-34] - - Added implementation to report the plugin dependencies as well. - Added IT's for reporting updates about dependencies in plugins, - plugins defined in pluginManagement. + Added processDependencyManagement option to control the reporting + of dependencyManagement. + Thanks to Bruce Brouwer. + +* [Fixed Issue 94][issue-94] + + introduced allowMajorUpdates, allowMinorUpdates, + allowIncrementalUpdates. + introduced allowAnyUpdates for compatibility which + will be removed in 3.0.0 of the plugin. + +* [Fixed Issue 34][issue-34] + + Added implementation to report the plugin dependencies as well. + Added IT's for reporting updates about dependencies in plugins, + plugins defined in pluginManagement. * [Fixed Issue 162][issue-162] Upgraded cobertura-maven-plugin used in report section to 2.7. - - [issue-34]: https://github.com/mojohaus/versions-maven-plugin/issues/34 [issue-37]: https://github.com/mojohaus/versions-maven-plugin/issues/37 @@ -153,6 +150,6 @@ [issue-198]: https://github.com/mojohaus/versions-maven-plugin/issues/198 [issue-237]: https://github.com/mojohaus/versions-maven-plugin/issues/237 [issue-256]: https://github.com/mojohaus/versions-maven-plugin/issues/256 - [pull-189]: https://github.com/mojohaus/versions-maven-plugin/pull/189 [pull-252]: https://github.com/mojohaus/versions-maven-plugin/pull/252 + diff --git a/pom.xml b/pom.xml index 0bc3b3d30a..9575b58f23 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ org.codehaus.mojo mojo-parent - 80 + 82 org.codehaus.mojo.versions diff --git a/versions-maven-plugin/src/site/markdown/examples/compare-dependencies.md b/versions-maven-plugin/src/site/markdown/examples/compare-dependencies.md index 6d24c00155..8d1bd56bd1 100644 --- a/versions-maven-plugin/src/site/markdown/examples/compare-dependencies.md +++ b/versions-maven-plugin/src/site/markdown/examples/compare-dependencies.md @@ -10,7 +10,7 @@ regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - https://www.apache.org/licenses/LICENSE-2.0 +https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY @@ -21,9 +21,9 @@ under the License. # Compare dependency versions -The `compare-dependencies` goal can be used to compare the dependencies in the current project to +The `compare-dependencies` goal can be used to compare the dependencies in the current project to the dependencyManagement of a remote project. This is useful, for example, for finding differences -between the current project dependencies and an organizational bill of materials (BOM) pom. +between the current project dependencies and an organizational bill of materials (BOM) pom. You specify the remote groupId, artifactId, and the version to which the current project should be compared, for example @@ -31,7 +31,7 @@ should be compared, for example mvn versions:compare-dependencies -DremotePom=org.foo:bom-pom:1.0 ``` -By default the list of dependency differences will be output to the command line. This can be +By default the list of dependency differences will be output to the command line. This can be written to a file using the "reportOutputFile" parameter. ```sh diff --git a/versions-maven-plugin/src/site/markdown/examples/display-dependency-updates.md b/versions-maven-plugin/src/site/markdown/examples/display-dependency-updates.md index 46d4342689..31d26752d6 100644 --- a/versions-maven-plugin/src/site/markdown/examples/display-dependency-updates.md +++ b/versions-maven-plugin/src/site/markdown/examples/display-dependency-updates.md @@ -10,7 +10,7 @@ regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - https://www.apache.org/licenses/LICENSE-2.0 +https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY diff --git a/versions-maven-plugin/src/site/markdown/examples/display-plugin-updates.md b/versions-maven-plugin/src/site/markdown/examples/display-plugin-updates.md index a8d8d41713..2bde29fa42 100644 --- a/versions-maven-plugin/src/site/markdown/examples/display-plugin-updates.md +++ b/versions-maven-plugin/src/site/markdown/examples/display-plugin-updates.md @@ -10,7 +10,7 @@ regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - https://www.apache.org/licenses/LICENSE-2.0 +https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY @@ -310,7 +310,7 @@ And the following POM: ``` - produces the following output: +produces the following output: ```log [INFO] ------------------------------------------------------------------------ @@ -348,3 +348,4 @@ And the following POM: [INFO] Final Memory: 17M/81M [INFO] ------------------------------------------------------------------------ ``` + diff --git a/versions-maven-plugin/src/site/markdown/examples/display-property-updates.md b/versions-maven-plugin/src/site/markdown/examples/display-property-updates.md index f74637d0be..3ec01f8b25 100644 --- a/versions-maven-plugin/src/site/markdown/examples/display-property-updates.md +++ b/versions-maven-plugin/src/site/markdown/examples/display-property-updates.md @@ -10,7 +10,7 @@ regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - https://www.apache.org/licenses/LICENSE-2.0 +https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY @@ -82,3 +82,4 @@ Which produces the following output: [INFO] Final Memory: 11M/24M [INFO] ------------------------------------------------------------------------ ``` + diff --git a/versions-maven-plugin/src/site/markdown/examples/lock-snapshots.md b/versions-maven-plugin/src/site/markdown/examples/lock-snapshots.md index dd457bbf9c..9aeecf3162 100644 --- a/versions-maven-plugin/src/site/markdown/examples/lock-snapshots.md +++ b/versions-maven-plugin/src/site/markdown/examples/lock-snapshots.md @@ -10,7 +10,7 @@ regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - https://www.apache.org/licenses/LICENSE-2.0 +https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY @@ -43,12 +43,12 @@ A pom will most likely specify -SNAPSHOT versions for certain dependencies. Using the `lock-snapshots` goal, the version can be locked down to the specific timestamped snapshot version used in the build. - + ```sh mvn versions:lock-snapshots ``` - The pom dependencies are modified to look like the following. +The pom dependencies are modified to look like the following. ```xml @@ -74,7 +74,7 @@ The `includes` and `excludes` parameters follow the format `groupId:artifactId:t Use a comma separated list to specify multiple includes. Wildcards (*) can also be used to match multiple values. -This example will match anything with the groupId "org.codehaus.plexus" and anything with the groupId and +This example will match anything with the groupId "org.codehaus.plexus" and anything with the groupId and artifactId matching "junit". ```sh @@ -96,3 +96,4 @@ While this example will only process the `project/dependencies` section of your ```sh mvn versions:lock-snapshots -DprocessDependencyManagement=false ``` + diff --git a/versions-maven-plugin/src/site/markdown/examples/recording-changes.md b/versions-maven-plugin/src/site/markdown/examples/recording-changes.md index fd5dac3ebe..2cd0f3c6f2 100644 --- a/versions-maven-plugin/src/site/markdown/examples/recording-changes.md +++ b/versions-maven-plugin/src/site/markdown/examples/recording-changes.md @@ -10,7 +10,7 @@ regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - https://www.apache.org/licenses/LICENSE-2.0 +https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY diff --git a/versions-maven-plugin/src/site/markdown/examples/resolve-ranges.md b/versions-maven-plugin/src/site/markdown/examples/resolve-ranges.md index 78c54ecb8c..3ce1fdc236 100644 --- a/versions-maven-plugin/src/site/markdown/examples/resolve-ranges.md +++ b/versions-maven-plugin/src/site/markdown/examples/resolve-ranges.md @@ -10,7 +10,7 @@ regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - https://www.apache.org/licenses/LICENSE-2.0 +https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY @@ -49,12 +49,12 @@ A pom may specify version ranges for certain dependencies. Using the resolve-ranges goal, the version ranges can be set to the specific version used in the build. - + ```sh mvn versions:resolve-ranges ``` - The pom dependencies are modified to look like the following. +The pom dependencies are modified to look like the following. ```xml @@ -91,8 +91,8 @@ mvn versions:resolve-ranges -Dincludes=org.codehaus.plexus:plexus-utils The `includes` and `excludes` parameters follow the format `groupId:artifactId:type:classifier`. Use a comma separated separated list to specify multiple includes. Wildcards (*) can also be used to match multiple values. - -This example will match anything with the groupId "org.codehaus.plexus" and anything with the groupId and + +This example will match anything with the groupId "org.codehaus.plexus" and anything with the groupId and artifactId matching "junit". ```sh @@ -114,3 +114,4 @@ While this example will only process the `project/dependencies` section of your ```sh mvn versions:resolve-ranges -DprocessDependencyManagement=false ``` + diff --git a/versions-maven-plugin/src/site/markdown/examples/set.md b/versions-maven-plugin/src/site/markdown/examples/set.md index 20c18a4e29..71117d8ce7 100644 --- a/versions-maven-plugin/src/site/markdown/examples/set.md +++ b/versions-maven-plugin/src/site/markdown/examples/set.md @@ -10,7 +10,7 @@ regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - https://www.apache.org/licenses/LICENSE-2.0 +https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY @@ -149,6 +149,7 @@ Now if we run ```sh mvn versions:set -DnewVersion=2.1.0-SNAPSHOT -f enforcer/enforcer-api/pom.xml ``` + ```log [INFO] Scanning for projects... [INFO] ------------------------------------------------------------------------ @@ -188,4 +189,4 @@ which will become origins of change. ```sh mvn versions:set -DgroupId=org.apache.maven.* -DartifactId=* -DoldVersion=2.* -DnewVersion=2.1.0-SNAPSHOT ``` - \ No newline at end of file + diff --git a/versions-maven-plugin/src/site/markdown/examples/setaggregator.md b/versions-maven-plugin/src/site/markdown/examples/setaggregator.md index a11b0099b5..732e0fb37e 100644 --- a/versions-maven-plugin/src/site/markdown/examples/setaggregator.md +++ b/versions-maven-plugin/src/site/markdown/examples/setaggregator.md @@ -10,7 +10,7 @@ regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - https://www.apache.org/licenses/LICENSE-2.0 +https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY @@ -18,6 +18,7 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> + # Changing the version of an Aggregator Let us assume we have a multi-module project which consists of the following @@ -178,7 +179,6 @@ call. To get that working you need to add supplemental command line parameters: - ```shell mvn versions:set -DnewVersion=3.6.0 -DoldVersion=* -DgroupId=* -DartifactId=* ``` @@ -242,3 +242,4 @@ So in end the result of the above call looks like this: [INFO] Final Memory: 23M/310M [INFO] ------------------------------------------------------------------------ ``` + diff --git a/versions-maven-plugin/src/site/markdown/examples/unlock-snapshots.md b/versions-maven-plugin/src/site/markdown/examples/unlock-snapshots.md index 1f65e0e5b4..40158efff5 100644 --- a/versions-maven-plugin/src/site/markdown/examples/unlock-snapshots.md +++ b/versions-maven-plugin/src/site/markdown/examples/unlock-snapshots.md @@ -10,7 +10,7 @@ regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - https://www.apache.org/licenses/LICENSE-2.0 +https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY @@ -75,7 +75,7 @@ The `includes` and `excludes` parameters follow the format `groupId:artifactId:t Use a comma separated separated list to specify multiple includes. Wildcards (*) can also be used to match multiple values. -This example will match anything with the groupId "org.codehaus.plexus" and anything with the groupId and +This example will match anything with the groupId "org.codehaus.plexus" and anything with the groupId and artifactId matching "junit". ```shell @@ -97,3 +97,4 @@ While this example will only process the `project/dependencies` section of your ```shell mvn versions:unlock-snapshots -DprocessDependencyManagement=false ``` + diff --git a/versions-maven-plugin/src/site/markdown/examples/update-child-modules.md b/versions-maven-plugin/src/site/markdown/examples/update-child-modules.md index f9a8443b40..f440dfc49f 100644 --- a/versions-maven-plugin/src/site/markdown/examples/update-child-modules.md +++ b/versions-maven-plugin/src/site/markdown/examples/update-child-modules.md @@ -10,7 +10,7 @@ regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - https://www.apache.org/licenses/LICENSE-2.0 +https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY @@ -45,7 +45,7 @@ Reason: Cannot find parent: com.foo.bar:bar for project: com.foo.bar:bar-child:j The above example was for a project structured like this: - /pom.xml - - /bar-child/pom.xml + - /bar-child/pom.xml With `/pom.xml` looking like @@ -98,7 +98,7 @@ to run the goal. mvn -N versions:update-child-modules ``` - Which produces the following output: +Which produces the following output: ```log [INFO] Scanning for projects... diff --git a/versions-maven-plugin/src/site/markdown/examples/update-parent.md b/versions-maven-plugin/src/site/markdown/examples/update-parent.md index a1e86c501f..a9f22f2e77 100644 --- a/versions-maven-plugin/src/site/markdown/examples/update-parent.md +++ b/versions-maven-plugin/src/site/markdown/examples/update-parent.md @@ -10,7 +10,7 @@ regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - https://www.apache.org/licenses/LICENSE-2.0 +https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY @@ -58,9 +58,10 @@ You can restrict the versions to be considered: mvn versions:update-parent "-DparentVersion=[14,16)" ``` -Note that, by default, -SNAPSHOT versions are ignored. You can force snapshots to be +Note that, by default, -SNAPSHOT versions are ignored. You can force snapshots to be included with the allowSnapshots parameter: ```shell mvn versions:update-parent -DallowSnapshots=true ``` + diff --git a/versions-maven-plugin/src/site/markdown/examples/use-releases.md b/versions-maven-plugin/src/site/markdown/examples/use-releases.md index c313fe5613..86b60750f5 100644 --- a/versions-maven-plugin/src/site/markdown/examples/use-releases.md +++ b/versions-maven-plugin/src/site/markdown/examples/use-releases.md @@ -10,7 +10,7 @@ regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - https://www.apache.org/licenses/LICENSE-2.0 +https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY @@ -70,7 +70,7 @@ The `includes` and `excludes` parameters follow the format `groupId:artifactId:t Use a comma separated separated list to specify multiple includes. Wildcards (*) can also be used to match multiple values. -This example will match anything with the groupId "org.codehaus.plexus" and anything with the groupId and +This example will match anything with the groupId "org.codehaus.plexus" and anything with the groupId and artifactId matching "junit". ```shell @@ -92,3 +92,4 @@ While this example will only process the `project/dependencies` section of your ```shell mvn versions:use-releases -DprocessDependencyManagement=false ``` + diff --git a/versions-maven-plugin/src/site/markdown/faq.md b/versions-maven-plugin/src/site/markdown/faq.md index bbe89ee5fe..1244d5b43f 100644 --- a/versions-maven-plugin/src/site/markdown/faq.md +++ b/versions-maven-plugin/src/site/markdown/faq.md @@ -9,7 +9,7 @@ regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - https://www.apache.org/licenses/LICENSE-2.0 +https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY @@ -35,7 +35,7 @@ in the core of Maven expects that version numbers will have a very specific form ` . . - ` Where *MajorVersion*, *MinorVersion*, *IncrementalVersion* and *BuildNumber* are all numeric and *Qualifier* -is a string. If your version number does not match this format, then the entire version number is treated as being +is a string. If your version number does not match this format, then the entire version number is treated as being the *Qualifier*. Version numbers in maven are compared using the individual components, so *MajorVersion*, *MinorVersion*, @@ -56,9 +56,9 @@ then Maven will not know about versions that are available in your repositories. Here are some common reasons why your metadata can be invalid: - You are using a local repository as a remote repository. Stop, don't do this. The local repository -uses a separate set of metadata files from those used by a remote repository. There are tools available -to convert a local repository into a remote repository, but you're really better off using a repository -manager. + uses a separate set of metadata files from those used by a remote repository. There are tools available + to convert a local repository into a remote repository, but you're really better off using a repository + manager. - Artifacts have been deployed by non-maven metadata aware tools. - Tools that claim to be maven meta-data aware have clobbered the metadata files. diff --git a/versions-maven-plugin/src/site/markdown/index.md b/versions-maven-plugin/src/site/markdown/index.md index 7763624fba..a0f773e6b4 100644 --- a/versions-maven-plugin/src/site/markdown/index.md +++ b/versions-maven-plugin/src/site/markdown/index.md @@ -10,7 +10,7 @@ regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - https://www.apache.org/licenses/LICENSE-2.0 +https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY @@ -27,77 +27,77 @@ The Versions Plugin is used when you want to manage the versions of artifacts in The Versions Plugin has the following goals. * [versions:compare-dependencies](./compare-dependencies-mojo.html) compares the dependency versions of the current - project to the dependency management section of a remote project. +project to the dependency management section of a remote project. * [versions:display-dependency-updates](./display-dependency-updates-mojo.html) scans a project's dependencies and - produces a report of those dependencies which have newer versions available. +produces a report of those dependencies which have newer versions available. * [versions:display-plugin-updates](./display-plugin-updates-mojo.html) scans a project's plugins and produces a - report of those plugins which have newer versions available, taking care of Maven version prerequisites. +report of those plugins which have newer versions available, taking care of Maven version prerequisites. * [versions:display-property-updates](./display-property-updates-mojo.html) scans a project and produces a report of - those properties which are used to control artifact versions and which properties have newer versions available. +those properties which are used to control artifact versions and which properties have newer versions available. * [versions:update-parent](./update-parent-mojo.html) updates the parent section of a project so that it references the - newest available version. For example, if you use a corporate root POM, this goal can be helpful if you need - to ensure you are using the latest version of the corporate root POM. +newest available version. For example, if you use a corporate root POM, this goal can be helpful if you need +to ensure you are using the latest version of the corporate root POM. * [versions:update-properties](./update-properties-mojo.html) updates properties defined in a project so that they - correspond to the latest available version of specific dependencies. This can be useful if a suite of dependencies - must all be locked to one version. +correspond to the latest available version of specific dependencies. This can be useful if a suite of dependencies +must all be locked to one version. * [versions:update-property](./update-property-mojo.html) Sets a property to the latest version in a given range of - associated artifacts. +associated artifacts. * [versions:update-child-modules](./update-child-modules-mojo.html) updates the parent section of the child modules - of a project so the version matches the version of the current project. For example, if you have an aggregator pom - that is also the parent for the projects that it aggregates and the children and parent versions get out of sync, this - mojo can help fix the versions of the child modules. (Note you may need to invoke Maven with the -N option in order to - run this goal if your project is broken so badly that it cannot build because of the version mis-match). +of a project so the version matches the version of the current project. For example, if you have an aggregator pom +that is also the parent for the projects that it aggregates and the children and parent versions get out of sync, this +mojo can help fix the versions of the child modules. (Note you may need to invoke Maven with the -N option in order to +run this goal if your project is broken so badly that it cannot build because of the version mis-match). * [versions:lock-snapshots](./lock-snapshots-mojo.html) searches the pom for all -SNAPSHOT versions and replaces them - with the current timestamp version of that -SNAPSHOT, e.g. -20090327.172306-4 +with the current timestamp version of that -SNAPSHOT, e.g. -20090327.172306-4 * [versions:unlock-snapshots](./unlock-snapshots-mojo.html) searches the pom for all timestamp locked snapshot versions - and replaces them with -SNAPSHOT. +and replaces them with -SNAPSHOT. * [versions:resolve-ranges](./resolve-ranges-mojo.html) finds dependencies using version ranges and resolves the range - to the specific version being used. +to the specific version being used. * [versions:set](./set-mojo.html) can be used to set the project version from the command line. * [versions:set-property](./set-property-mojo.html) can be used to set one or multiple properties to a given version from the command line. * [versions:use-releases](./use-releases-mojo.html) searches the pom for all -SNAPSHOT versions which have been - released and replaces them with the corresponding release version. +released and replaces them with the corresponding release version. * [versions:use-next-releases](./use-next-releases-mojo.html) searches the pom for all non-SNAPSHOT versions which - have been a newer release and replaces them with the next release version. +have been a newer release and replaces them with the next release version. * [versions:use-latest-releases](./use-latest-releases-mojo.html) searches the pom for all dependencies using *release* versions (i.e. not SNAPSHOT and not versions ending with a year-month-day suffix) and replaces them with the latest *release* version. * [versions:use-next-snapshots](./use-next-snapshots-mojo.html) searches the pom for all non-SNAPSHOT versions which - have been a newer -SNAPSHOT version and replaces them with the next -SNAPSHOT version. +have been a newer -SNAPSHOT version and replaces them with the next -SNAPSHOT version. * [versions:use-latest-snapshots](./use-latest-snapshots-mojo.html) searches the pom for all non-SNAPSHOT versions - which have been a newer -SNAPSHOT version and replaces them with the latest -SNAPSHOT version. +which have been a newer -SNAPSHOT version and replaces them with the latest -SNAPSHOT version. * [versions:use-next-versions](./use-next-versions-mojo.html) searches the pom for all versions which - have been a newer version and replaces them with the next version. +have been a newer version and replaces them with the next version. * [versions:use-latest-versions](./use-latest-versions-mojo.html) searches the pom for all versions which - have been a newer version and replaces them with the latest version. +have been a newer version and replaces them with the latest version. * [versions:use-dep-version](./use-dep-version-mojo.html) updates a dependency to a specific version. * [versions:commit](./commit-mojo.html) removes the `pom.xml.versionsBackup` files. Forms one half of the - built-in "Poor Man's SCM". +built-in "Poor Man's SCM". * [versions:revert](./revert-mojo.html) restores the `pom.xml` files from the `pom.xml.versionsBackup` files. - Forms one half of the built-in "Poor Man's SCM". +Forms one half of the built-in "Poor Man's SCM". ## Reporting goals overview The Versions Plugin has the following reporting goals. * [versions:dependency-updates-report](./dependency-updates-report-mojo.html) produces a report of those - project dependencies which have newer versions available. -* [versions:dependency-updates-aggregate-report](./dependency-updates-aggregate-report-mojo.html) produces an aggregated - report(project + its submodules) of those dependencies which have newer versions available. +project dependencies which have newer versions available. +* [versions:dependency-updates-aggregate-report](./dependency-updates-aggregate-report-mojo.html) produces an aggregated +report(project + its submodules) of those dependencies which have newer versions available. * [versions:plugin-updates-report](./plugin-updates-report-mojo.html) produces a report of those plugins which have - newer versions available. +newer versions available. * [versions:plugin-updates-aggregate-report](./plugin-updates-aggregate-report-mojo.html) produces an aggregated report - (project + its submodules) of those plugins which have newer versions available. +(project + its submodules) of those plugins which have newer versions available. * [versions:property-updates-report](./property-updates-report-mojo.html) produces a report of - those properties which are used to control artifact versions and which properties have newer versions available. +those properties which are used to control artifact versions and which properties have newer versions available. * [versions:property-updates-aggregate-report](./property-updates-aggregate-report-mojo.html) produces an aggregated - report(project + its submodules) of those properties which are used to control artifact versions and - which properties have newer versions available. +report(project + its submodules) of those properties which are used to control artifact versions and +which properties have newer versions available. * [versions:parent-updates-report](./parent-updates-report-mojo.html) produces a report on possible parent artifact - upgrades. +upgrades. ## Enforcer rules overview The Versions Plugin currently provides one Maven Enforcer Plugin rule: * [maxDependencyUpdates](../versions-enforcer/index.html) allows the user to specify a maximum number of updates which, - if exceeded, will trigger the enforcer plugin to fail. +if exceeded, will trigger the enforcer plugin to fail. ## Usage diff --git a/versions-model-report/src/site/markdown/xsd/index.md b/versions-model-report/src/site/markdown/xsd/index.md index cb033a4706..a923670f6a 100644 --- a/versions-model-report/src/site/markdown/xsd/index.md +++ b/versions-model-report/src/site/markdown/xsd/index.md @@ -11,4 +11,3 @@ Versions - XML schemas for reports - [plugin-updates-report-2.0.0.xsd](plugin-updates-report-2.0.0.xsd) - [property-updates-report-2.0.0.xsd](property-updates-report-2.0.0.xsd) - diff --git a/versions-model/src/site/markdown/xsd/index.md b/versions-model/src/site/markdown/xsd/index.md index 3df2653a53..e82698085e 100644 --- a/versions-model/src/site/markdown/xsd/index.md +++ b/versions-model/src/site/markdown/xsd/index.md @@ -5,7 +5,7 @@ date: 2022-10-17 Versions - XML schemas for ruleSet -====================== +================================== - [rule-2.1.0.xsd](rule-2.1.0.xsd) - [rule-2.0.0.xsd](https://www.mojohaus.org/versions-maven-plugin/xsd/rule-2.0.0.xsd)