JUnit 5

This repository is the home of the next generation of JUnit, JUnit 5.

Latest Releases

General Availability (GA): JUnit 5.7.0 (September 13, 2020)
Preview (Milestone/Release Candidate): n/a

Documentation

Contributing

Contributions to JUnit 5 are both welcomed and appreciated. For specific guidelines
regarding contributions, please see CONTRIBUTING.md in the root directory of the
project. Those willing to use milestone or SNAPSHOT releases are encouraged
to file feature requests and bug reports using the project's
issue tracker. Issues marked with an
up-for-grabs
label are specifically targeted for community contributions.

Getting Help

Ask JUnit 5 related questions on StackOverflow or chat with the team and the community on Gitter.

Continuous Integration Builds

Official CI build server for JUnit 5. Used to perform quick checks on submitted pull
requests and for build matrices including the latest released OpenJDK and early access
builds of the next OpenJDK.

Code Coverage

Code coverage using JaCoCo for the latest build is available on Codecov.

A code coverage report can also be generated locally via the Gradle Wrapper by
executing gradlew -PenableJaCoCo clean jacocoRootReport. The results will be available
in build/reports/jacoco/jacocoRootReport/html/index.html.

Gradle Build Scans and Build Caching

JUnit 5 utilizes Gradle Enterprise for Build Scans and the
Remote Build Cache. An example build scan for JUnit 5 can be viewed
here. Currently, only core team members can
publish build scans. The remote build cache, however, is enabled by default for everyone
so that local builds can reuse task outputs from previous CI builds.

Building from Source

You need JDK 15 to build JUnit 5.

All modules can be built with the Gradle Wrapper using the following command.

gradlew clean assemble

All modules can be tested with the Gradle Wrapper using the following command.

gradlew clean test

Since Gradle has excellent incremental build support, you can usually omit executing the
clean task.

Installing in Local Maven Repository

All modules can be installed with the Gradle Wrapper in a local Maven repository for
consumption in other projects via the following command.

gradlew clean publishToMavenLocal

Dependency Metadata

Consult the Dependency Metadata section of the User Guide for a list of all artifacts
of the JUnit Platform, JUnit Jupiter, and JUnit Vintage.

l0s/junit5