Skip to content

SETUP.md: document mvn install for downstream Registry builds #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jgoodyear merged 1 commit into from
Sep 13, 2026
Merged

SETUP.md: document mvn install for downstream Registry builds #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions SETUP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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-<version>-SNAPSHOT.jar` to `~/.m2`, where the
Registry build resolves it.

To fix formatting violations automatically, run:
```bash
mvn spotless:apply
Expand Down