Skip to content

Commit

Permalink
Merge pull request #104 from pitest/release/1.2.1
Browse files Browse the repository at this point in the history
update readme for 1.2.1
  • Loading branch information
hcoles authored Oct 24, 2023
2 parents 797354c + 8f4251c commit 71fab4a
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ Adds support to pitest for JUnit 5 platform test engines, e.g. Jupiter, Cucumber

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.pitest/pitest-junit5-plugin/badge.svg?style=flat)](https://maven-badges.herokuapp.com/maven-central/org.pitest/pitest-junit5-plugin)

Release 1.2.1 requires pitest 1.15.2 or above.

Release 1.2.0 requires pitest 1.14.0 or above.

When used with the pitest-maven plugin, it will automatically work with JUnit platform 1.5.0 to 1.10.0-M1 (and probably above).
When used with the pitest-maven plugin, or version 1.15.0 of the gradle plugin, it will automatically work with JUnit platform 1.5.0 to 1.10.0-M1 (and probably above).

When used with the pitest gradle plugin a dependency must be added to a compatible version of junit-platform-launcher. Depending on how the gradle project is configured the must be added wither a scope of either pitest, or a testImplementation.
When used with earlier versions of the pitest gradle plugin a dependency must be added to a compatible version of junit-platform-launcher. Depending on how the gradle project is configured the must be added wither a scope of either pitest, or a testImplementation.

Older versions of the plugin must be matched to both the pitest and junit version in use as below.

Expand Down Expand Up @@ -38,12 +40,12 @@ To activate the plugin it must be placed on the classpath of the pitest tool (**
<plugin>
<groupId>org.pitest</groupId>
<artifactId>pitest-maven</artifactId>
<version>1.10.3</version>
<version>1.15.2</version>
<dependencies>
<dependency>
<groupId>org.pitest</groupId>
<artifactId>pitest-junit5-plugin</artifactId>
<version>1.1.1</version>
<version>1.2.1</version>
</dependency>
</dependencies>
</plugin>
Expand All @@ -56,13 +58,13 @@ For Pitest configuration options, have a look at http://pitest.org/quickstart/ma
```
plugins {
id 'java'
id 'info.solidsoft.pitest' version '1.7.4'
id 'info.solidsoft.pitest' version '1.15.0'
}
pitest {
//adds dependency to org.pitest:pitest-junit5-plugin and sets "testPlugin" to "junit5"
junit5PluginVersion = '1.1.1'
pitestVersion = '1.10.3'
junit5PluginVersion = '1.2.1'
pitestVersion = '1.15.2'
// ...
}
```
Expand All @@ -71,6 +73,10 @@ See [gradle-pitest-plugin documentation](https://github.com/szpak/gradle-pitest-

## Release Notes

### 1.2.1

* #103 Report errors and failures during scan stage

### 1.1.1

* #73 Automatically disable parallel mode
Expand Down

0 comments on commit 71fab4a

Please sign in to comment.