Merge pull request #127 from xdev-software/develop

v2.0.0

Author: JohannesRabauer

.config/pmd/ruleset.xml

@@ -59,6 +59,9 @@
 		<!-- Prohibits singleton pattern -->
 		<exclude name="MutableStaticState"/>
 
+		<!-- Checks LoC, already handled by Checkstyle -->
+		<exclude name="NcssCount"/>
+
 		<!-- Some override methods or Junit require this -->
 		<exclude name="SignatureDeclareThrowsException"/>
 

.github/workflows/test-deploy.yml

@@ -24,7 +24,7 @@ jobs:
         gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }}
 
     - name: Publish to OSSRH
-      run: ../mvnw -B deploy -Possrh
+      run: ../mvnw -B deploy -Possrh -DskipTests
       working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
       env:
         MAVEN_CENTRAL_USERNAME: ${{ secrets.S01_OSS_SONATYPE_MAVEN_USERNAME }}

CHANGELOG.md

@@ -1,3 +1,11 @@
+# 2.0.0
+
+* Restructured root to improve performance with IDs in entities
+* Implemented auto migration for older version (<2.0.0).
+  Added [XDEV MicroMigration](https://github.com/xdev-software/micro-migration) as dependency.
+* Updated EclipseStore version to 1.4.0
+* Updated Spring to version 3.3.2
+
 # 1.0.10
 
 * Optimistic locking with @Version now possible

CONTRIBUTING.md

@@ -44,3 +44,31 @@ If the ``develop`` is ready for release, create a pull request to the ``master``
 
 When the release is finished do the following:
 * Merge the auto-generated PR (with the incremented version number) back into the ``develop``
+
+### Release failures
+
+There are 2 modes of release failure:
+1. The remote server was e.g. down and non of the artifacts got published
+2. There was a build failure during release and only parts of the artifacts got released
+
+In case 1 we can re-release the existing version,<br/>in case 2 we have to release a new version when we can't get the artifacts deleted (as is the case with Maven Central)
+
+#### How-to: Re-Releasing an existing version
+
+1. Delete the release on GitHub
+2. Delete the release Git tag from the repo (locally and remote!)
+3. Delete the ``master``-Branch and re-create it from the ``develop`` branch (or reset it to the state before the release-workflow commits have been done)
+    * This requires __temporarily__ removing the branch protection
+    * Once this was done a new release is triggered immediately!
+
+#### How-to: Releasing a new version
+
+1. Merge the ``master`` branch back into ``develop`` (or another temporary branch)
+2. Make sure all master branch versions are prepared for a new release<br/>e.g. if the broken release was ``1.0.0`` the version should now be at ``1.0.1-SNAPSHOT`` - the ``SNAPSHOT`` is important for the workflow!
+3. Mark the broken release as broken e.g. inside the Changelog, GitHub Release page, etc.<br/>
+You can use something like this:
+    ```
+    > [!WARNING]
+    > This release is broken as my cat accidentally clicked the abort button during the process
+    ```
+4. Merge the changes back into the ``master`` branch to trigger a new release

README.md

@@ -54,7 +54,8 @@ instructions** are in the documentation](https://xdev-software.github.io/spring-
 | ``<= 1.0.2``              | ``17`` | ``3.2.2``   | ``1.1.0``    |
 | ``1.0.3/1.0.4``           | ``17`` | ``3.2.3``   | ``1.2.0``    |
 | ``1.0.5-1.0.7``           | ``17`` | ``3.2.5``   | ``1.3.2``    |
-| ``>= 1.0.8``              | ``17`` | ``3.3.1``   | ``1.3.2``    |
+| ``1.0.8-1.0.10``          | ``17`` | ``3.3.1``   | ``1.3.2``    |
+| ``>= 2.0.0``              | ``17`` | ``3.3.2``   | ``1.4.0``    |
 
 ## Demo
 

docs/antora.yml

@@ -1,14 +1,14 @@
 name: ROOT
 title: Spring-Data-Eclipse-Store
 version: master
-display_version: '1.0.10'
+display_version: '2.0.0'
 start_page: index.adoc
 nav:
   - modules/ROOT/nav.adoc
 asciidoc:
   attributes:
     product-name: 'Spring-Data-Eclipse-Store'
-    display-version: '1.0.10'
-    maven-version: '1.0.10'
+    display-version: '2.0.0'
+    maven-version: '2.0.0'
     page-editable: false
     page-out-of-support: false

pom.xml

@@ -6,7 +6,7 @@
 
 	<groupId>software.xdev</groupId>
 	<artifactId>spring-data-eclipse-store-root</artifactId>
-	<version>1.0.11-SNAPSHOT</version>
+	<version>2.0.0-SNAPSHOT</version>
 	<packaging>pom</packaging>
 
 	<organization>

spring-data-eclipse-store-benchmark/pom.xml

@@ -5,11 +5,11 @@
 	<parent>
 		<groupId>software.xdev</groupId>
 		<artifactId>spring-data-eclipse-store-root</artifactId>
-		<version>1.0.11-SNAPSHOT</version>
+		<version>2.0.0-SNAPSHOT</version>
 	</parent>
 
 	<artifactId>spring-data-eclipse-store-benchmark</artifactId>
-	<version>1.0.11-SNAPSHOT</version>
+	<version>2.0.0-SNAPSHOT</version>
 	<packaging>jar</packaging>
 
 	<inceptionYear>2023</inceptionYear>
@@ -25,7 +25,7 @@
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
 
-		<org.springframework.boot.version>3.3.1</org.springframework.boot.version>
+		<org.springframework.boot.version>3.3.2</org.springframework.boot.version>
 		<jmh.version>1.37</jmh.version>
 	</properties>
 

spring-data-eclipse-store-demo/pom.xml

@@ -7,11 +7,11 @@
 	<parent>
 		<groupId>software.xdev</groupId>
 		<artifactId>spring-data-eclipse-store-root</artifactId>
-		<version>1.0.11-SNAPSHOT</version>
+		<version>2.0.0-SNAPSHOT</version>
 	</parent>
 
 	<artifactId>spring-data-eclipse-store-demo</artifactId>
-	<version>1.0.11-SNAPSHOT</version>
+	<version>2.0.0-SNAPSHOT</version>
 	<packaging>jar</packaging>
 
 	<organization>
@@ -28,7 +28,7 @@
 
 		<mainClass>software.xdev.spring.data.eclipse.store.demo.complex.ComplexDemoApplication</mainClass>
 
-		<org.springframework.boot.version>3.3.1</org.springframework.boot.version>
+		<org.springframework.boot.version>3.3.2</org.springframework.boot.version>
 	</properties>
 
 	<dependencyManagement>
@@ -64,16 +64,6 @@
 		</dependency>
 
 
-		<dependency>
-			<groupId>org.junit.jupiter</groupId>
-			<artifactId>junit-jupiter</artifactId>
-			<scope>test</scope>
-		</dependency>
-		<dependency>
-			<groupId>org.junit.jupiter</groupId>
-			<artifactId>junit-jupiter</artifactId>
-			<scope>test</scope>
-		</dependency>
 		<dependency>
 			<groupId>org.junit.jupiter</groupId>
 			<artifactId>junit-jupiter</artifactId>
@@ -82,13 +72,13 @@
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-test</artifactId>
+			<scope>test</scope>
 			<exclusions>
 				<exclusion>
 					<artifactId>spring-boot-starter-logging</artifactId>
 					<groupId>org.springframework.boot</groupId>
 				</exclusion>
 			</exclusions>
-			<scope>test</scope>
 		</dependency>
 	</dependencies>
 

spring-data-eclipse-store-jpa/pom.xml

@@ -7,11 +7,11 @@
 	<parent>
 		<groupId>software.xdev</groupId>
 		<artifactId>spring-data-eclipse-store-root</artifactId>
-		<version>1.0.11-SNAPSHOT</version>
+		<version>2.0.0-SNAPSHOT</version>
 	</parent>
 
 	<artifactId>spring-data-eclipse-store-jpa</artifactId>
-	<version>1.0.11-SNAPSHOT</version>
+	<version>2.0.0-SNAPSHOT</version>
 	<packaging>jar</packaging>
 
 	<inceptionYear>2023</inceptionYear>
@@ -30,7 +30,7 @@
 
 		<mainClass>software.xdev.spring.data.eclipse.store.demo.complex.ComplexDemoApplication</mainClass>
 
-		<org.springframework.boot.version>3.3.1</org.springframework.boot.version>
+		<org.springframework.boot.version>3.3.2</org.springframework.boot.version>
 	</properties>
 
 	<dependencyManagement>