Skip to content

Commit

Permalink
[Gradle Release Plugin] - pre tag commit: 'v1.9.2'.
Browse files Browse the repository at this point in the history
  • Loading branch information
Jenkins committed Feb 27, 2023
2 parents f5d9c51 + 3bf2e3e commit 6b398af
Show file tree
Hide file tree
Showing 28 changed files with 3,108 additions and 405 deletions.
30 changes: 15 additions & 15 deletions README.md
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.9.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-bom/1.9.1/jar)
[![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.9.1&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-core/1.9.1)
[![Reference](https://img.shields.io/static/v1?label=Reference&message=1.9.1&color=orange)](https://skuzzle.github.io/snapshot-tests/reference/1.9.1)
[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.9.2&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-bom/1.9.2/jar)
[![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.9.2&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-core/1.9.2)
[![Reference](https://img.shields.io/static/v1?label=Reference&message=1.9.2&color=orange)](https://skuzzle.github.io/snapshot-tests/reference/1.9.2)
[![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.9.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.9.1/jar)
- [x] JUnit5 (tested against `5.9.2`) via [snapshot-tests-junit5](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-junit5/1.9.2/jar)
- [x] JUnit4 (tested against `4.13.2`) via [snapshot-tests-junit4](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-junit4/1.9.2/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.9.1/jar))
- [x] Json via [snapshot-tests-jackson](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-jackson/1.9.1/jar)
- [x] XML via [snapshot-tests-jaxb](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-jaxb/1.9.1/jar) xor [snapshot-tests-jaxb-jakarta](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-jaxb-jakarta/1.9.1/jar)
- [x] HTML via [snapshot-tests-html](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-html/1.9.1/jar)
- [x] generic plain text (included by default via [snapshot-tests-core](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-core/1.9.2/jar))
- [x] Json via [snapshot-tests-jackson](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-jackson/1.9.2/jar)
- [x] XML via [snapshot-tests-jaxb](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-jaxb/1.9.2/jar) xor [snapshot-tests-jaxb-jakarta](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-jaxb-jakarta/1.9.2/jar)
- [x] HTML via [snapshot-tests-html](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-html/1.9.2/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.9.1](https://github.com/skuzzle/snapshot-tests/releases/tag/v1.9.1)
release [1.9.2](https://github.com/skuzzle/snapshot-tests/releases/tag/v1.9.2)

### 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.9.1](https://skuzzle.github.io/snapshot-tests/reference/1.9.1): Points to a specific version
* [1.9.2](https://skuzzle.github.io/snapshot-tests/reference/1.9.2): 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.9.1</version>
<version>1.9.2</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>de.skuzzle.test</groupId>
<artifactId>snapshot-tests-jackson</artifactId>
<version>1.9.1</version>
<version>1.9.2</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-jackson</artifactId>
<version>1.9.1</version>
<version>1.9.2</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-jackson:1.9.1') {
testImplementation('de.skuzzle.test:snapshot-tests-jackson:1.9.2') {
exclude group: 'org.junit.jupiter', module: 'junit-jupiter-api'
}
```
Expand Down
83 changes: 38 additions & 45 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,47 +7,40 @@
>
> Check the resp. section in the README!
**All Changes**:

* [#49](https://github.com/skuzzle/snapshot-tests/issues/49): Delete context files as well when deleting orphaned snapshots
* [#57](https://github.com/skuzzle/snapshot-tests/issues/57): Support XML namespaces in XPaths when using custom comparison rules
* [#61](https://github.com/skuzzle/snapshot-tests/issues/61): `@SnapshotDirectory` is not allowed anymore on test methods, only on test class
* [#64](https://github.com/skuzzle/snapshot-tests/issues/64): Migrate build to gradle
* [#66](https://github.com/skuzzle/snapshot-tests/issues/66): XmlSnapshot.withEnableXPathDebugging: Boolean parameter 'enabled' not taken into account
* [#71](https://github.com/skuzzle/snapshot-tests/issues/71): Gracefully support JUnit5 nested tests
* [#73](https://github.com/skuzzle/snapshot-tests/issues/73): `MarshallerSupplier` functional interface is not public
* [#74](https://github.com/skuzzle/snapshot-tests/issues/74): Add recursive directory scanning via `DirectoriesFrom.recursive()`
* Deprecate `PathFilter` in favor of `TestFileFilter` and `TestDirectoryFilter`
* Improve format and information density of XPath debugging (can be enabled with `XmlSnapshot.withEnableXPathDebugging(true)`)
* Improve removal of internal stack frames from stacktraces of assertion errors
* `SnapshotException` is now an unchecked exception
* DSL no longer throws checked exceptions
* Update to jackson `2.14.2` (coming from `2.10.5`)
### Fixes

* [#76](https://github.com/skuzzle/snapshot-tests/issues/76): Improved lazy XPath rule configuration
* [#77](https://github.com/skuzzle/snapshot-tests/issues/77): Small XPath performance optimization
* [#78](https://github.com/skuzzle/snapshot-tests/issues/78): Throw AssertionError only once
* [#79](https://github.com/skuzzle/snapshot-tests/issues/79): Filter out internal stack frames from all AssertionErrors

### Build
[#75](https://github.com/skuzzle/snapshot-tests/issues/75): Use `Project.copy` instead of `Copy` task

## Reference Documentation

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

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


## 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.9.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-bom/1.9.1/jar)
[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.9.2&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-bom/1.9.2/jar)

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

```
testImplementation(platform("de.skuzzle.test:snapshot-tests-bom:1.9.1"))
testImplementation(platform("de.skuzzle.test:snapshot-tests-bom:1.9.2"))
```

## Artifacts
Expand All @@ -58,36 +51,36 @@ testImplementation(platform("de.skuzzle.test:snapshot-tests-bom:1.9.1"))

If you are using **JUnit5**:

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

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

```
testImplementation("de.skuzzle.test:snapshot-tests-junit5:1.9.1")
testImplementation("de.skuzzle.test:snapshot-tests-junit5:1.9.2")
```

If you are using **JUnit4**:

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

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

```
testImplementation("de.skuzzle.test:snapshot-tests-junit4:1.9.1")
testImplementation("de.skuzzle.test:snapshot-tests-junit4:1.9.2")
```

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

If you want **JSON** based snapshots:

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

```xml
<dependency>
<groupId>de.skuzzle.test</groupId>
<artifactId>snapshot-tests-jackson</artifactId>
<version>1.9.1</version>
<version>1.9.2</version>
<scope>test</scope>
</dependency>
```

```
testImplementation("de.skuzzle.test:snapshot-tests-jackson:1.9.1")
testImplementation("de.skuzzle.test:snapshot-tests-jackson:1.9.2")
```

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.9.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-jaxb/1.9.1/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.9.1&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-jaxb/1.9.1)
[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.9.2&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-jaxb/1.9.2/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.9.2&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-jaxb/1.9.2)

```xml
<dependency>
<groupId>de.skuzzle.test</groupId>
<artifactId>snapshot-tests-jaxb</artifactId>
<version>1.9.1</version>
<version>1.9.2</version>
<scope>test</scope>
</dependency>
```

```
testImplementation("de.skuzzle.test:snapshot-tests-jaxb:1.9.1")
testImplementation("de.skuzzle.test:snapshot-tests-jaxb:1.9.2")
```

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

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

```xml
<dependency>
<groupId>de.skuzzle.test</groupId>
<artifactId>snapshot-tests-jaxb-jakarta</artifactId>
<version>1.9.1</version>
<version>1.9.2</version>
<scope>test</scope>
</dependency>
```

```
testImplementation("de.skuzzle.test:snapshot-tests-jaxb-jakarta:1.9.1")
testImplementation("de.skuzzle.test:snapshot-tests-jaxb-jakarta:1.9.2")
```

If you want **HTML** based snapshots:

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

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

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

Expand All @@ -170,35 +163,35 @@ testImplementation("de.skuzzle.test:snapshot-tests-html:1.9.1")

Directory Params

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

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

```
testImplementation("de.skuzzle.test:snapshot-tests-directory-params:1.9.1")
testImplementation("de.skuzzle.test:snapshot-tests-directory-params:1.9.2")
```

Object normalization (⚠️ Experimental⚠)

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

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

```
testImplementation("de.skuzzle.test:snapshot-tests-normalize:1.9.1")
testImplementation("de.skuzzle.test:snapshot-tests-normalize:1.9.2")
```
</details>
1 change: 1 addition & 0 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ githubRelease {
token provider({ project.findProperty("gh_token") })
owner githubUser
repo githubRepo
draft true
body provider({
file("RELEASE_NOTES.md").getText()
})
Expand Down
Binary file added docs/reference/1.9.2/images/eclipse_diff.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 6b398af

Please sign in to comment.