Adjust readme, add dependency to BOM

skuzzle · Jan 13, 2023 · 87d0125 · 87d0125
1 parent 05bdfb4
commit 87d0125
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 25 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,4 +1,6 @@
-ℹ️ **Info**: starting with this version, instead of depending on `snapshot-tests-core` you should depend on either `snapshot-tests-junit5` or `snapshot-tests-junit4`. This will become mandatory with the next major version! ℹ️ 
+⚠️ℹ️ **Info**: 
+starting with this version, instead of depending on `snapshot-tests-core` you should depend on either 
+`snapshot-tests-junit5` or `snapshot-tests-junit4`. This will become mandatory with the next major version!
 
 * [#52](https://github.com/skuzzle/snapshot-tests/issues/52): Test methods that contain at least on `disabled` assertion and o failed assertions will properly be marked as 'skipped' by the test framework
 * Build against JUnit `5.9.2` (coming from `5.9.1`)
@@ -34,7 +36,10 @@ testImplementation(platform("de.skuzzle.test:snapshot-tests-bom:1.8.0-SNAPSHOT")
 ## Artifacts
 
 ### Choose a test framework
-If you are using JUnit5:
+
+ℹ️ ALl options include support for plain text snapshots.
+
+If you are using **JUnit5**:
 
 [![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.8.0-SNAPSHOT&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-junit5/1.8.0-SNAPSHOT/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.8.0-SNAPSHOT&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-junit5/1.8.0-SNAPSHOT)
 
@@ -52,29 +57,29 @@ testImplementation 'de.skuzzle.test:snapshot-tests-junit5:1.8.0-SNAPSHOT'
 testImplementation("de.skuzzle.test:snapshot-tests-junit5:1.8.0-SNAPSHOT")
 ```
 
-If you are using JUnit4:
+If you are using **JUnit4**:
 
-[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.8.0-SNAPSHOT&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-junit5/1.8.0-SNAPSHOT/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.8.0-SNAPSHOT&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-junit5/1.8.0-SNAPSHOT)
+[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.8.0-SNAPSHOT&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-junit4/1.8.0-SNAPSHOT/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.8.0-SNAPSHOT&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-junit4/1.8.0-SNAPSHOT)
 
 ```xml
 <dependency>
     <groupId>de.skuzzle.test</groupId>
-    <artifactId>snapshot-tests-junit5</artifactId>
+    <artifactId>snapshot-tests-junit4</artifactId>
     <version>1.8.0-SNAPSHOT</version>
     <scope>test</scope>
 </dependency>
 ```
 
 ```
-testImplementation 'de.skuzzle.test:snapshot-tests-junit5:1.8.0-SNAPSHOT'
-testImplementation("de.skuzzle.test:snapshot-tests-junit5:1.8.0-SNAPSHOT")
+testImplementation 'de.skuzzle.test:snapshot-tests-junit4:1.8.0-SNAPSHOT'
+testImplementation("de.skuzzle.test:snapshot-tests-junit4:1.8.0-SNAPSHOT")
 ```
 
 ### Choose a snapshot format (optional)
 <details>
     <summary>Show supported snapshot format artifacts</summary>
 
-If you want json based snapshots:
+If you want **JSON** based snapshots:
 
 [![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.8.0-SNAPSHOT&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-jackson/1.8.0-SNAPSHOT/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.8.0-SNAPSHOT&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-jackson/1.8.0-SNAPSHOT)
 
@@ -92,7 +97,7 @@ testImplementation 'de.skuzzle.test:snapshot-tests-jackson:1.8.0-SNAPSHOT'
 testImplementation("de.skuzzle.test:snapshot-tests-jackson:1.8.0-SNAPSHOT")
 ```
 
-If you want xml based snapshots using `javax.xml` legacy namespaces:
+If you want **XML** based snapshots using jaxb and `javax.xml` legacy namespaces:
 
 [![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.8.0-SNAPSHOT&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-jaxb/1.8.0-SNAPSHOT/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.8.0-SNAPSHOT&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-jaxb/1.8.0-SNAPSHOT)
 
@@ -110,7 +115,7 @@ testImplementation 'de.skuzzle.test:snapshot-tests-jaxb:1.8.0-SNAPSHOT'
 testImplementation("de.skuzzle.test:snapshot-tests-jaxb:1.8.0-SNAPSHOT")
 ```
 
-If you want xml based snapshots using new `jakarta.xml` namespaces:
+If you want **XML** based snapshots using jaxb new `jakarta.xml` namespaces:
 
 [![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.8.0-SNAPSHOT&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-jaxb-jakarta/1.8.0-SNAPSHOT/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.8.0-SNAPSHOT&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-jaxb-jakarta/1.8.0-SNAPSHOT)
 
@@ -128,7 +133,7 @@ testImplementation 'de.skuzzle.test:snapshot-tests-jaxb-jakarta:1.8.0-SNAPSHOT'
 testImplementation("de.skuzzle.test:snapshot-tests-jaxb-jakarta:1.8.0-SNAPSHOT")
 ```
 
-If you want HTML based snapshots:
+If you want **HTML** based snapshots:
 
 [![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.8.0-SNAPSHOT&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-html/1.8.0-SNAPSHOT/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.8.0-SNAPSHOT&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-html/1.8.0-SNAPSHOT)
 
@@ -170,7 +175,7 @@ testImplementation 'de.skuzzle.test:snapshot-tests-directory-params:1.8.0-SNAPSH
 testImplementation("de.skuzzle.test:snapshot-tests-directory-params:1.8.0-SNAPSHOT")
 ```
 
-Object normalization
+Object normalization (⚠️ Experimental⚠)
 
 [![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.8.0-SNAPSHOT&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-normalize/1.8.0-SNAPSHOT/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.8.0-SNAPSHOT&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-normalize/1.8.0-SNAPSHOT)
 

diff --git a/readme/RELEASE_NOTES.md b/readme/RELEASE_NOTES.md
@@ -1,4 +1,6 @@
-ℹ️ **Info**: starting with this version, instead of depending on `snapshot-tests-core` you should depend on either `snapshot-tests-junit5` or `snapshot-tests-junit4`. This will become mandatory with the next major version! ℹ️ 
+⚠️ℹ️ **Info**: 
+starting with this version, instead of depending on `snapshot-tests-core` you should depend on either 
+`snapshot-tests-junit5` or `snapshot-tests-junit4`. This will become mandatory with the next major version!
 
 * [#52](https://github.com/skuzzle/snapshot-tests/issues/52): Test methods that contain at least on `disabled` assertion and o failed assertions will properly be marked as 'skipped' by the test framework
 * Build against JUnit `5.9.2` (coming from `5.9.1`)
@@ -34,7 +36,10 @@ testImplementation(platform("${project.groupId}:snapshot-tests-bom:${project.ver
 ## Artifacts
 
 ### Choose a test framework
-If you are using JUnit5:
+
+ℹ️ ALl options include support for plain text snapshots.
+
+If you are using **JUnit5**:
 
 [![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=${project.version}&color=blue)](https://search.maven.org/artifact/${project.groupId}/snapshot-tests-junit5/${project.version}/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=${project.version}&color=orange)](http://www.javadoc.io/doc/${project.groupId}/snapshot-tests-junit5/${project.version})
 
@@ -52,29 +57,29 @@ testImplementation '${project.groupId}:snapshot-tests-junit5:${project.version}'
 testImplementation("${project.groupId}:snapshot-tests-junit5:${project.version}")
 ```
 
-If you are using JUnit4:
+If you are using **JUnit4**:
 
-[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=${project.version}&color=blue)](https://search.maven.org/artifact/${project.groupId}/snapshot-tests-junit5/${project.version}/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=${project.version}&color=orange)](http://www.javadoc.io/doc/${project.groupId}/snapshot-tests-junit5/${project.version})
+[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=${project.version}&color=blue)](https://search.maven.org/artifact/${project.groupId}/snapshot-tests-junit4/${project.version}/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=${project.version}&color=orange)](http://www.javadoc.io/doc/${project.groupId}/snapshot-tests-junit4/${project.version})
 
 ```xml
 <dependency>
     <groupId>${project.groupId}</groupId>
-    <artifactId>snapshot-tests-junit5</artifactId>
+    <artifactId>snapshot-tests-junit4</artifactId>
     <version>${project.version}</version>
     <scope>test</scope>
 </dependency>
 ```
 
 ```
-testImplementation '${project.groupId}:snapshot-tests-junit5:${project.version}'
-testImplementation("${project.groupId}:snapshot-tests-junit5:${project.version}")
+testImplementation '${project.groupId}:snapshot-tests-junit4:${project.version}'
+testImplementation("${project.groupId}:snapshot-tests-junit4:${project.version}")
 ```
 
 ### Choose a snapshot format (optional)
 <details>
     <summary>Show supported snapshot format artifacts</summary>
 
-If you want json based snapshots:
+If you want **JSON** based snapshots:
 
 [![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=${project.version}&color=blue)](https://search.maven.org/artifact/${project.groupId}/snapshot-tests-jackson/${project.version}/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=${project.version}&color=orange)](http://www.javadoc.io/doc/${project.groupId}/snapshot-tests-jackson/${project.version})
 
@@ -92,7 +97,7 @@ testImplementation '${project.groupId}:snapshot-tests-jackson:${project.version}
 testImplementation("${project.groupId}:snapshot-tests-jackson:${project.version}")
 ```
 
-If you want xml based snapshots using `javax.xml` legacy namespaces:
+If you want **XML** based snapshots using jaxb and `javax.xml` legacy namespaces:
 
 [![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=${project.version}&color=blue)](https://search.maven.org/artifact/${project.groupId}/snapshot-tests-jaxb/${project.version}/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=${project.version}&color=orange)](http://www.javadoc.io/doc/${project.groupId}/snapshot-tests-jaxb/${project.version})
 
@@ -110,7 +115,7 @@ testImplementation '${project.groupId}:snapshot-tests-jaxb:${project.version}'
 testImplementation("${project.groupId}:snapshot-tests-jaxb:${project.version}")
 ```
 
-If you want xml based snapshots using new `jakarta.xml` namespaces:
+If you want **XML** based snapshots using jaxb new `jakarta.xml` namespaces:
 
 [![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=${project.version}&color=blue)](https://search.maven.org/artifact/${project.groupId}/snapshot-tests-jaxb-jakarta/${project.version}/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=${project.version}&color=orange)](http://www.javadoc.io/doc/${project.groupId}/snapshot-tests-jaxb-jakarta/${project.version})
 
@@ -128,7 +133,7 @@ testImplementation '${project.groupId}:snapshot-tests-jaxb-jakarta:${project.ver
 testImplementation("${project.groupId}:snapshot-tests-jaxb-jakarta:${project.version}")
 ```
 
-If you want HTML based snapshots:
+If you want **HTML** based snapshots:
 
 [![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=${project.version}&color=blue)](https://search.maven.org/artifact/${project.groupId}/snapshot-tests-html/${project.version}/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=${project.version}&color=orange)](http://www.javadoc.io/doc/${project.groupId}/snapshot-tests-html/${project.version})
 
@@ -170,7 +175,7 @@ testImplementation '${project.groupId}:snapshot-tests-directory-params:${project
 testImplementation("${project.groupId}:snapshot-tests-directory-params:${project.version}")
 ```
 
-Object normalization
+Object normalization (⚠️ Experimental⚠)
 
 [![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=${project.version}&color=blue)](https://search.maven.org/artifact/${project.groupId}/snapshot-tests-normalize/${project.version}/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=${project.version}&color=orange)](http://www.javadoc.io/doc/${project.groupId}/snapshot-tests-normalize/${project.version})
 

diff --git a/snapshot-tests-bom/pom.xml b/snapshot-tests-bom/pom.xml
@@ -26,6 +26,11 @@
                 <artifactId>snapshot-tests-junit4</artifactId>
                 <version>${project.version}</version>
             </dependency>
+            <dependency>
+                <groupId>${project.groupId}</groupId>
+                <artifactId>snapshot-tests-junit5</artifactId>
+                <version>${project.version}</version>
+            </dependency>
             <dependency>
                 <groupId>${project.groupId}</groupId>
                 <artifactId>snapshot-tests-jackson</artifactId>

diff --git a/snapshot-tests-junit5/src/main/java/de/skuzzle/test/snapshots/junit5/package-info.java b/snapshot-tests-junit5/src/main/java/de/skuzzle/test/snapshots/junit5/package-info.java
@@ -1,5 +1,5 @@
 /**
- * Integration fro JUnit4
+ * Integration for JUnit5
  */
 @API(status = Status.EXPERIMENTAL, since = "1.8.0")
 package de.skuzzle.test.snapshots.junit5;

diff --git a/...e/test/FilesAreProperlyProcessedTest_snapshots/testBomFilePlaceholdersResolved_0.snapshot b/...e/test/FilesAreProperlyProcessedTest_snapshots/testBomFilePlaceholdersResolved_0.snapshot
@@ -53,6 +53,11 @@ test-method: testBomFilePlaceholdersResolved
         <artifactId>snapshot-tests-junit4</artifactId>
         <version>1.8.0-SNAPSHOT</version>
       </dependency>
+      <dependency>
+        <groupId>de.skuzzle.test</groupId>
+        <artifactId>snapshot-tests-junit5</artifactId>
+        <version>1.8.0-SNAPSHOT</version>
+      </dependency>
       <dependency>
         <groupId>de.skuzzle.test</groupId>
         <artifactId>snapshot-tests-jackson</artifactId>