From ccbe3bf44a3c223e630dff857cef796922b1f37a Mon Sep 17 00:00:00 2001 From: NaveenKumar Namachivayam Date: Sat, 12 Sep 2026 20:01:15 -0400 Subject: [PATCH] SETUP.md: document mvn install for downstream Registry builds The setup guide documents `mvn clean verify` but not `mvn install`, so a contributor building sourcelume-registry locally hits an unresolvable org.apache.sourcelume:sourcelume-spec 0.0.1-SNAPSHOT dependency. Clarify that verify builds the JAR under target/ while install publishes it to ~/.m2 where the Registry resolves it. Apache-ai: Yes Generated-by: Devin (SWE-2 High) Reviewed-by: nkn --- SETUP.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/SETUP.md b/SETUP.md index b8943d0..029c018 100644 --- a/SETUP.md +++ b/SETUP.md @@ -138,6 +138,18 @@ resources into the Maven artifact. Verification includes code style checks: Spotless (palantir-java-format for Java, sortPom for `pom.xml`) and Checkstyle (`dev/checkstyle.xml`; minimal rules, e.g. tests must use JUnit 5). +To make the packaged artifact resolvable by local builds of downstream +projects (e.g. `sourcelume-registry`), install it into the local Maven +repository: + +```bash +mvn install +``` + +`mvn verify` only builds the JAR under `target/`; `mvn install` additionally +publishes `sourcelume-spec--SNAPSHOT.jar` to `~/.m2`, where the +Registry build resolves it. + To fix formatting violations automatically, run: ```bash mvn spotless:apply