Skip to content

Commit

Permalink
A couple doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
2m authored and maichler committed Jan 14, 2019
1 parent 7a98a6b commit d5b5eb8
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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).
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).
2 changes: 1 addition & 1 deletion src/plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit d5b5eb8

Please sign in to comment.