Merge pull request #77 from BorderTech/feature/version-plugin

Move versions-maven-plugin into an opt in profile

Author: jonathanaustin

.github/workflows/github-actions-build.yml

@@ -25,7 +25,7 @@ jobs:
         restore-keys: ${{ runner.os }}-m2
 
     - name: Build Test and Verify
-      run: mvn -B -U clean install -Dmaven.javadoc.skip=true
+      run: mvn -B -U clean install -Dmaven.javadoc.skip=true -Pdisplay-versions
 
     - name: SonarCloud Scan
       run: |

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Change log
 
 ## Release in-progress
+* Move versions-maven-plugin into a profile display-versions to allow projects to opt in or out #74
 * Switch from travis-ci to GitHub Actions #75
 
 ## 1.0.17

README.md

@@ -94,7 +94,6 @@ The qa-parent runs quality assurance checks on your java code using tools such a
 The qa-parent also runs:
   - the [OWASP plugin](https://jeremylong.github.io/DependencyCheck/dependency-check-maven/index.html) to check security vulnerabilities
   - the [Enforcer plugin](https://maven.apache.org/enforcer/maven-enforcer-plugin/) to check dependency convergence
-  - the [Version checker plugin](https://www.mojohaus.org/versions-maven-plugin/) to report project dependencies that have new versions
   - the [JaCoCo plugin](https://www.eclemma.org/jacoco/trunk/doc/maven.html) for code coverage reports
   - the [Surefire plugin](https://maven.apache.org/surefire/maven-surefire-plugin) for running unit tests
 
@@ -104,6 +103,10 @@ The qa-parent inherits all of the release functionality from bordertech-parent.
 
 The qa-parent provides a profile `quick-build` that for convenience skips all tests and QA. This is very useful when developing a project and a quick build of the project is required.
 
+#### display-versions profile
+
+The qa-parent provides a profile `display-versions` that uses the [Version checker plugin](https://www.mojohaus.org/versions-maven-plugin/) to report project dependencies that have new versions.
+
 ### build-tools
 
 This is primarily a shared resources module used by qa-parent and potentially other BorderTech maven modules.

qa-parent/pom.xml

@@ -77,6 +77,7 @@
 		<bt.spotbugs.version>4.1.4</bt.spotbugs.version>
 		<bt.findsecbugs.plugin.version>1.11.0</bt.findsecbugs.plugin.version>
 		<bt.owasp.plugin.version>6.0.2</bt.owasp.plugin.version>
+		<bt.versions.plugin>2.8.1</bt.versions.plugin>
 
 	</properties>
 
@@ -109,6 +110,34 @@
 				<maven.javadoc.skip>true</maven.javadoc.skip>
 			</properties>
 		</profile>
+
+		<!-- Profile to display new dependency versions in the build console. -->
+		<!-- The versions plugin doesnot honor skip property on the display goals. As this can be an expensive process and cannot be skipped it is not included by default. -->
+		<profile>
+			<id>display-versions</id>
+			<build>
+				<plugins>
+					<plugin>
+						<groupId>org.codehaus.mojo</groupId>
+						<artifactId>versions-maven-plugin</artifactId>
+						<version>${bt.versions.plugin}</version>
+						<executions>
+							<execution>
+								<id>display-version-updates</id>
+								<phase>verify</phase>
+								<goals>
+									<goal>display-dependency-updates</goal>
+									<goal>display-parent-updates</goal>
+									<goal>display-plugin-updates</goal>
+									<goal>display-property-updates</goal>
+								</goals>
+							</execution>
+						</executions>
+					</plugin>
+				</plugins>
+			</build>
+		</profile>
+
 	</profiles>
 
 	<dependencyManagement>
@@ -333,25 +362,6 @@
 				</executions>
 			</plugin>
 
-			<!-- Display dependency versions -->
-			<plugin>
-				<groupId>org.codehaus.mojo</groupId>
-				<artifactId>versions-maven-plugin</artifactId>
-				<version>2.8.1</version>
-				<executions>
-					<execution>
-						<id>display-version-updates</id>
-						<phase>verify</phase>
-						<goals>
-							<goal>display-dependency-updates</goal>
-							<goal>display-parent-updates</goal>
-							<goal>display-plugin-updates</goal>
-							<goal>display-property-updates</goal>
-						</goals>
-					</execution>
-				</executions>
-			</plugin>
-
 		</plugins>
 	</build>