Merge pull request #16 from rnc/BR2

Add automatic updating of README
project-ncl · Feb 4, 2025 · 39e24f5 · 39e24f5
2 parents 6b9bfed + 0d64b0f
commit 39e24f5
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -95,10 +95,14 @@ Note that configuration for `impsort-maven-plugin` has also been added as its a
 A typical pom could contain:
 
 ```
+<properties
+   <spotless-maven-plugin.version>2.44.2</spotless-maven-plugin.version>
+</properties>
+
 <plugin>
   <groupId>com.diffplug.spotless</groupId>
   <artifactId>spotless-maven-plugin</artifactId>
-  <version>2.44.2</version>
+  <version>${spotless-maven-plugin.version}</version>
   <dependencies>
     <dependency>
       <groupId>org.jboss.pnc</groupId>
@@ -110,7 +114,7 @@ A typical pom could contain:
     <java>
       <removeUnusedImports/>
       <importOrder>
-        <order>java,javax,jakarta,org,com</order>
+        <file>java-import-order.txt</file>
       </importOrder>
       <eclipse>
         <file>java-formatter.xml</file>

diff --git a/pom.xml b/pom.xml
@@ -52,6 +52,17 @@
                         </archive>
                     </configuration>
                 </plugin>
+                <plugin>
+                    <groupId>io.github.floverfelt</groupId>
+                    <artifactId>find-and-replace-maven-plugin</artifactId>
+                    <version>1.2.0</version>
+                    <configuration>
+                        <replacementType>file-contents</replacementType>
+                        <fileMask>.md</fileMask>d
+                        <findRegex>&lt;version&gt;[0-9].*&lt;/version&gt;</findRegex>
+                        <replaceValue>&lt;version&gt;${project.version}&lt;/version&gt;</replaceValue>
+                    </configuration>
+                </plugin>
             </plugins>
         </pluginManagement>
     </build>
@@ -61,6 +72,24 @@
             <id>release</id>
             <build>
                 <plugins>
+                    <plugin>
+                        <groupId>org.apache.maven.plugins</groupId>
+                        <artifactId>maven-release-plugin</artifactId>
+                        <version>2.5.3</version>
+                        <configuration>
+                            <preparationGoals>-Prelease clean find-and-replace:find-and-replace scm:checkin verify</preparationGoals>
+                            <completionGoals>-Prelease clean verify</completionGoals>
+                        </configuration>
+                    </plugin>
+                    <plugin>
+                        <groupId>org.apache.maven.plugins</groupId>
+                        <artifactId>maven-scm-plugin</artifactId>
+                        <version>2.1.0</version>
+                        <configuration>
+                            <message>[maven-scm-plugin] Set ${project.version} version in README.md</message>
+                            <includes>README.md</includes>
+                        </configuration>
+                    </plugin>
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-gpg-plugin</artifactId>