From d5b5eb8ad422667987fd18d1dd8093ee3c5a375c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martynas=20Mickevi=C4=8Dius?= Date: Mon, 14 Jan 2019 14:05:16 +0700 Subject: [PATCH] A couple doc updates --- README.md | 4 ++-- src/plugin/README.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fa1a20c..d96f878 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Jupiter Interface An implementation of [SBT's test interface](https://github.com/sbt/test-interface) for [JUnit Jupiter](http://junit.org/junit5). This allows you to run JUnit 5 tests from [SBT](http://www.scala-sbt.org/). -The code is split into a runtime library `jupiter-interface` and an SBT plugin `sbt-jupiter-interface`. The runtime library is written in pure Java and does all the heavy lifting like collecting and running tests. The SBT plugin makes the runtime library available to the SBT build by adding it to `sbt.Keys.testFrameworks` and as project `test dependency`. It also overwrites `sbt.Keys.detectTests` with a custom task that uses JUnits discovery mechanism to collect available tests. This step is necessary since SBT is currently not capable of detecting package private test classes. +The code is split into a runtime library `jupiter-interface` and an SBT plugin `sbt-jupiter-interface`. The runtime library is written in pure Java and does all the heavy lifting like collecting and running tests. The SBT plugin makes the runtime library available to the SBT build by adding it to `sbt.Keys.testFrameworks`. It also overwrites `sbt.Keys.detectTests` with a custom task that uses JUnits discovery mechanism to collect available tests. This step is necessary since SBT is currently not capable of detecting package private test classes. ## Usage @@ -86,4 +86,4 @@ Or use them with the test-quick and test-only commands: ## Credits -This plugin is heavily inspired by [JUnit Interface](https://github.com/sbt/junit-interface) and the console launcher from [JUnit Team](https://github.com/junit-team/junit5). Parts of the output capturing is based on code from [Apache Geronimo GShell](http://geronimo.apache.org/gshell/index.html). \ No newline at end of file +This plugin is heavily inspired by [JUnit Interface](https://github.com/sbt/junit-interface) and the console launcher from [JUnit Team](https://github.com/junit-team/junit5). Parts of the output capturing is based on code from [Apache Geronimo GShell](http://geronimo.apache.org/gshell/index.html). diff --git a/src/plugin/README.md b/src/plugin/README.md index 109993b..a892441 100644 --- a/src/plugin/README.md +++ b/src/plugin/README.md @@ -8,7 +8,7 @@ In order to make SBT generally aware of another test framework, `sbt-jupiter-int project/plugins.sbt: ``` -addSbtPlugin("net.aichler" % "sbt-jupiter-interface" % "0.7.1-SNAPSHOT") +addSbtPlugin("net.aichler" % "sbt-jupiter-interface" % "0.8.0") ``` Additionally a test dependency to this plugins runtime library is required for every module which wants to run `JUnit 5` tests.