From d24c4ef572e2995b466c2d5a5e154ebe95101ca9 Mon Sep 17 00:00:00 2001 From: Caleb Cushing Date: Thu, 27 Nov 2025 22:06:44 -0500 Subject: [PATCH] docs: document how to run tests with ./gradlew check Includes commands from project dir and monorepo root, plus notes about zero-tests fail-fast. Co-authored-by: Junie --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4dbebe8..582cda3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -20,6 +20,28 @@ add a way to export these to your `PATH` in your `~/.profile` - [Gradle](https://docs.gradle.org/current/userguide/command_line_interface.html) - [Yarn 4](https://yarnpkg.com/getting-started/install) (via Corepack) +## Running tests + +The simplest way to run all verification tasks (unit tests, static analysis, etc.) for a top‑level project is to execute the `check` task. + +From this project directory: + +```sh +cd java-commons +./gradlew check +``` + +Or from the monorepo root targeting this build: + +```sh +./gradlew -p java-commons check +``` + +Notes: + +- `check` will execute all configured test suites (e.g., unit tests). Builds here use our shared `our.javatest` conventions. +- Zero‑tests fail‑fast: modules that apply our test conventions must include at least one test under `src/test/java` (or Kotlin equivalent) or the build will fail. + #### Fetching Dependencies In order to get snapshots of dependencies, you must have a GitHub token in your `~/.gradle/gradle.properties` file. This file should look like: