Skip to content

Latest commit

 

History

History
116 lines (94 loc) · 2.94 KB

README.adoc

File metadata and controls

116 lines (94 loc) · 2.94 KB
Raw

truth-extensions

A library for common extensions for Truth.

Usage

Repository

To depend on a release, you need only depend on the official Maven central, or a mirror thereof. If you’re using Maven, this is automatic. Gradle users must:

build.gradle.kts
repositories {
    mavenCentral()
}

To depend on a SNAPSHOT version, you need to depend on the Sonatype snapshot repository:

pom.xml
<repositories>
  <repository>
    <id>sonatype-oss-snapshot</id>
    <url>https://oss.sonatype.org/content/repositories/snapshots</url>
    <releases>
      <enabled>false</enabled>
    </releases>
    <snapshots>
      <enabled>true</enabled>
    </snapshots>
  </repository>
</repositories>
build.gradle.kts
repositories {
    maven("https://oss.sonatype.org/content/repositories/snapshots")
}

Artifact

You may want to depend upon the bill-of-materials for the library as follows:

pom.xml
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>dev.mardroemmar</groupId>
      <artifactId>truth-extensions-bom</artifactId>
      <version>0.1.0</version>
      <classifier>pom</classifier>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>
build.gradle.kts
dependencies {
    enforcedPlatform("dev.mardroemmar:truth-extensions-bom:0.1.0")
}

Modules

truth-extensions-currency

The truth-extensions-currency module provides java.util.Currency-related extensions.

You may depend on it as follows, assuming you use the bill-of-materials:

pom.xml
<dependencies>
  <dependency>
    <groupId>dev.mardroemmar</groupId>
    <artifactId>truth-extensions-currency</artifactId>
  </dependency>
</dependencies>
build.gradle.kts
dependencies {
    testImplementation("dev.mardroemmar:truth-extensions-currency")
    // or other scopes if you'd prefer.
}

Java

This project currently uses Java 8. The project has a policy of supporting at least the 2 newest long-term-support (LTS) versions of Java: any older versions are always subject to be removed in a MAJOR version bump. This means that e.g. version 1.0.0 with Java 8 will never drop Java 8, but rather bump to 2.0.0 along with moving to Java 11. This does not necessarily mean there are plans for this; see the issue tracker for more information on future plans.

Licence

This project is licensed under the MIT licence. Because of this, the project is freely distributable and usable, both by proprietary and free (as in libre) software. You need not ask for permission to use the project in any way; all usages are welcome within the terms of the licence.