Skip to content
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
SPDX-FileCopyrightText: Copyright © 2024 - 2025 Caleb Cushing
SPDX-FileCopyrightText: Copyright © 2024, 2025 Caleb Cushing

SPDX-License-Identifier: CC-BY-NC-4.0
-->
Expand All @@ -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:
Expand Down
Loading