Skip to content

Commit

Permalink
[Gradle Release Plugin] - pre tag commit: 'v1.10.1'.
Browse files Browse the repository at this point in the history
  • Loading branch information
Jenkins committed Mar 30, 2023
2 parents 267a653 + bc5ec83 commit 4a3c863
Show file tree
Hide file tree
Showing 9 changed files with 2,754 additions and 92 deletions.
30 changes: 15 additions & 15 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- This file is auto generated during release from readme/README.md -->

[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.0&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-bom/1.10.0/jar)
[![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.0&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-core/1.10.0)
[![Reference](https://img.shields.io/static/v1?label=Reference&message=1.10.0&color=orange)](https://skuzzle.github.io/snapshot-tests/reference/1.10.0)
[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-bom/1.10.1/jar)
[![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.1&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-core/1.10.1)
[![Reference](https://img.shields.io/static/v1?label=Reference&message=1.10.1&color=orange)](https://skuzzle.github.io/snapshot-tests/reference/1.10.1)
[![Coverage Status](https://coveralls.io/repos/github/skuzzle/snapshot-tests/badge.svg?branch=main)](https://coveralls.io/github/skuzzle/snapshot-tests?branch=main)
[![Twitter Follow](https://img.shields.io/twitter/follow/ProjectPolly.svg?style=social)](https://twitter.com/ProjectPolly)

Expand All @@ -16,26 +16,26 @@ actual object against the stored snapshot.
- [x] Requires Java 11, supports Java 17

Supported test frameworks:
- [x] JUnit5 (tested against `5.9.2`) via [snapshot-tests-junit5](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-junit5/1.10.0/jar)
- [x] JUnit4 (tested against `4.13.2`) via [snapshot-tests-junit4](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-junit4/1.10.0/jar)
- [x] JUnit5 (tested against `5.9.2`) via [snapshot-tests-junit5](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-junit5/1.10.1/jar)
- [x] JUnit4 (tested against `4.13.2`) via [snapshot-tests-junit4](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-junit4/1.10.1/jar)

Supported snapshot formats:
- [x] generic plain text (included by default via [snapshot-tests-core](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-core/1.10.0/jar))
- [x] Json via [snapshot-tests-json](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-json/1.10.0/jar)
- [x] XML via [snapshot-tests-xml](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-xml/1.10.0/jar) xor [snapshot-tests-xml-legacy](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-xml-legacy/1.10.0/jar)
- [x] HTML via [snapshot-tests-html](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-html/1.10.0/jar)
- [x] generic plain text (included by default via [snapshot-tests-core](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-core/1.10.1/jar))
- [x] Json via [snapshot-tests-json](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-json/1.10.1/jar)
- [x] XML via [snapshot-tests-xml](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-xml/1.10.1/jar) xor [snapshot-tests-xml-legacy](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-xml-legacy/1.10.1/jar)
- [x] HTML via [snapshot-tests-html](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-html/1.10.1/jar)

Read more about snapshot testing in this accompanying [blog post](https://simon.taddiken.net/the-case-for-snapshot-testing/).

### Latest Maven Central coordinates

Please check out the GitHub release page to find Maven & Gradle coordinates for the latest
release [1.10.0](https://github.com/skuzzle/snapshot-tests/releases/tag/v1.10.0)
release [1.10.1](https://github.com/skuzzle/snapshot-tests/releases/tag/v1.10.1)

### Reference Documentation
Starting with release `1.8.0` we provide a new external reference documentation:
* [Latest](https://skuzzle.github.io/snapshot-tests/reference/latest): Always points to the latest version
* [1.10.0](https://skuzzle.github.io/snapshot-tests/reference/1.10.0): Points to a specific version
* [1.10.1](https://skuzzle.github.io/snapshot-tests/reference/1.10.1): Points to a specific version

Over the course of the next releases most of the contents of this README will be transitioned into the new reference
documentation.
Expand All @@ -49,13 +49,13 @@ Add the following dependencies to your build
<dependency>
<groupId>de.skuzzle.test</groupId>
<artifactId>snapshot-tests-junit5</artifactId>
<version>1.10.0</version>
<version>1.10.1</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>de.skuzzle.test</groupId>
<artifactId>snapshot-tests-json</artifactId>
<version>1.10.0</version>
<version>1.10.1</version>
<scope>test</scope>
</dependency>
```
Expand Down Expand Up @@ -113,7 +113,7 @@ add a dependency for your preferred snapshot format like `snapshot-tests-jackson
<dependency>
<groupId>de.skuzzle.test</groupId>
<artifactId>snapshot-tests-json</artifactId>
<version>1.10.0</version>
<version>1.10.1</version>
<scope>test</scope>
<exclusions>
<exclusion>
Expand All @@ -127,7 +127,7 @@ add a dependency for your preferred snapshot format like `snapshot-tests-jackson
or

```
testImplementation('de.skuzzle.test:snapshot-tests-json:1.10.0') {
testImplementation('de.skuzzle.test:snapshot-tests-json:1.10.1') {
exclude group: 'org.junit.jupiter', module: 'junit-jupiter-api'
}
```
Expand Down
76 changes: 33 additions & 43 deletions RELEASE_NOTES.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,43 +19,33 @@

### Changes

* [#67](https://github.com/skuzzle/snapshot-tests/issues/67): Fix inconsistent naming of structured data modules
* [#60](https://github.com/skuzzle/snapshot-tests/issues/60): Internal API for plugging in test-framework specific behavior
* [#80](https://github.com/skuzzle/snapshot-tests/issues/80): Use spotless and reformat whole code base
* [#87](https://github.com/skuzzle/snapshot-tests/issues/87): Allow to configure diff format
* [#88](https://github.com/skuzzle/snapshot-tests/issues/88): Extract diff creation into own module
* [#44](https://github.com/skuzzle/snapshot-tests/issues/44)/[#90](https://github.com/skuzzle/snapshot-tests/issues/90): Add possibility to normalize line endings (according to local git config)

* Update to jsonassert `1.5.1` (coming from `1.5.0`)


* List [notable changes](https://skuzzle.github.io/snapshot-tests/reference/latest/#_notable_changes_in_this_release) since last release in reference documentation
* [#93](https://github.com/skuzzle/snapshot-tests/issues/93): Fix bug in determining the line ending from _git_


## Reference Documentation

[![Reference](https://img.shields.io/static/v1?label=Reference&message=1.10.0&color=orange)](https://skuzzle.github.io/snapshot-tests/reference/1.10.0)
[![Reference](https://img.shields.io/static/v1?label=Reference&message=1.10.1&color=orange)](https://skuzzle.github.io/snapshot-tests/reference/1.10.1)

Reference documentation for this release: https://skuzzle.github.io/snapshot-tests/reference/1.10.0
Reference documentation for this release: https://skuzzle.github.io/snapshot-tests/reference/1.10.1


## BOM Artifact
Manages the versions of all modules in case you are using multiple in your project

[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.0&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-bom/1.10.0/jar)
[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-bom/1.10.1/jar)

```xml
<dependency>
<groupId>de.skuzzle.test</groupId>
<artifactId>snapshot-tests-bom</artifactId>
<version>1.10.0</version>
<version>1.10.1</version>
<type>pom</type>
<scope>import</scope>
</dependency>
```

```
testImplementation(platform("de.skuzzle.test:snapshot-tests-bom:1.10.0"))
testImplementation(platform("de.skuzzle.test:snapshot-tests-bom:1.10.1"))
```

## Artifacts
Expand All @@ -66,36 +56,36 @@ testImplementation(platform("de.skuzzle.test:snapshot-tests-bom:1.10.0"))

If you are using **JUnit5**:

[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.0&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-junit5/1.10.0/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.0&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-junit5/1.10.0)
[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-junit5/1.10.1/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.1&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-junit5/1.10.1)

```xml
<dependency>
<groupId>de.skuzzle.test</groupId>
<artifactId>snapshot-tests-junit5</artifactId>
<version>1.10.0</version>
<version>1.10.1</version>
<scope>test</scope>
</dependency>
```

```
testImplementation("de.skuzzle.test:snapshot-tests-junit5:1.10.0")
testImplementation("de.skuzzle.test:snapshot-tests-junit5:1.10.1")
```

If you are using **JUnit4**:

[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.0&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-junit4/1.10.0/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.0&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-junit4/1.10.0)
[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-junit4/1.10.1/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.1&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-junit4/1.10.1)

```xml
<dependency>
<groupId>de.skuzzle.test</groupId>
<artifactId>snapshot-tests-junit4</artifactId>
<version>1.10.0</version>
<version>1.10.1</version>
<scope>test</scope>
</dependency>
```

```
testImplementation("de.skuzzle.test:snapshot-tests-junit4:1.10.0")
testImplementation("de.skuzzle.test:snapshot-tests-junit4:1.10.1")
```

### Choose a snapshot format (optional)
Expand All @@ -104,70 +94,70 @@ testImplementation("de.skuzzle.test:snapshot-tests-junit4:1.10.0")

If you want **JSON** based snapshots:

[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.0&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-json/1.10.0/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.0&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-jackson/1.10.0)
[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-json/1.10.1/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.1&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-jackson/1.10.1)

```xml
<dependency>
<groupId>de.skuzzle.test</groupId>
<artifactId>snapshot-tests-json</artifactId>
<version>1.10.0</version>
<version>1.10.1</version>
<scope>test</scope>
</dependency>
```

```
testImplementation("de.skuzzle.test:snapshot-tests-json:1.10.0")
testImplementation("de.skuzzle.test:snapshot-tests-json:1.10.1")
```

If you want **XML** based snapshots using jaxb and legacy `javax.xml` namespaces:

[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.0&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-xml-legacy/1.10.0/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.0&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-jaxb/1.10.0)
[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-xml-legacy/1.10.1/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.1&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-jaxb/1.10.1)

```xml
<dependency>
<groupId>de.skuzzle.test</groupId>
<artifactId>snapshot-tests-xml-legacy</artifactId>
<version>1.10.0</version>
<version>1.10.1</version>
<scope>test</scope>
</dependency>
```

```
testImplementation("de.skuzzle.test:snapshot-tests-xml-legacy:1.10.0")
testImplementation("de.skuzzle.test:snapshot-tests-xml-legacy:1.10.1")
```

If you want **XML** based snapshots using jaxb new `jakarta.xml` namespaces:

[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.0&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-xml/1.10.0/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.0&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-jaxb-jakarta/1.10.0)
[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-xml/1.10.1/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.1&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-jaxb-jakarta/1.10.1)

```xml
<dependency>
<groupId>de.skuzzle.test</groupId>
<artifactId>snapshot-tests-xml</artifactId>
<version>1.10.0</version>
<version>1.10.1</version>
<scope>test</scope>
</dependency>
```

```
testImplementation("de.skuzzle.test:snapshot-tests-xml:1.10.0")
testImplementation("de.skuzzle.test:snapshot-tests-xml:1.10.1")
```

If you want **HTML** based snapshots:

[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.0&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-html/1.10.0/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.0&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-html/1.10.0)
[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-html/1.10.1/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.1&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-html/1.10.1)

```xml
<dependency>
<groupId>de.skuzzle.test</groupId>
<artifactId>snapshot-tests-html</artifactId>
<version>1.10.0</version>
<version>1.10.1</version>
<scope>test</scope>
</dependency>
```

```
testImplementation("de.skuzzle.test:snapshot-tests-html:1.10.0")
testImplementation("de.skuzzle.test:snapshot-tests-html:1.10.1")
```
</details>

Expand All @@ -178,52 +168,52 @@ testImplementation("de.skuzzle.test:snapshot-tests-html:1.10.0")

Directory Params

[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.0&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-directory-params/1.10.0/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.0&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-directory-params/1.10.0)
[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-directory-params/1.10.1/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.1&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-directory-params/1.10.1)

```xml
<dependency>
<groupId>de.skuzzle.test</groupId>
<artifactId>snapshot-tests-directory-params</artifactId>
<version>1.10.0</version>
<version>1.10.1</version>
<scope>test</scope>
</dependency>
```

```
testImplementation("de.skuzzle.test:snapshot-tests-directory-params:1.10.0")
testImplementation("de.skuzzle.test:snapshot-tests-directory-params:1.10.1")
```

Diff-Tool

[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.0&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/diff-tool/1.10.0/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.0&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/diff-tool/1.10.0)
[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/diff-tool/1.10.1/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.1&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/diff-tool/1.10.1)

```xml
<dependency>
<groupId>de.skuzzle.test</groupId>
<artifactId>diff-tool</artifactId>
<version>1.10.0</version>
<version>1.10.1</version>
<scope>test</scope>
</dependency>
```

```
testImplementation("de.skuzzle.test:diff-tool:1.10.0")
testImplementation("de.skuzzle.test:diff-tool:1.10.1")
```

Object normalization (⚠️ Experimental⚠)

[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.0&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-normalize/1.10.0/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.0&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-normalize/1.10.0)
[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.10.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-normalize/1.10.1/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.10.1&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-normalize/1.10.1)

```xml
<dependency>
<groupId>de.skuzzle.test</groupId>
<artifactId>snapshot-tests-normalize</artifactId>
<version>1.10.0</version>
<version>1.10.1</version>
<scope>test</scope>
</dependency>
```

```
testImplementation("de.skuzzle.test:snapshot-tests-normalize:1.10.0")
testImplementation("de.skuzzle.test:snapshot-tests-normalize:1.10.1")
```
</details>
Loading

0 comments on commit 4a3c863

Please sign in to comment.