Skip to content

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

Merged
jgoodyear merged 1 commit into
apache:mainfrom
QAInsights:docs/setup-mvn-install
Sep 13, 2026
Merged

jgoodyear merged 1 commit into
apache:mainfrom
QAInsights:docs/setup-mvn-install

Conversation

@QAInsights

@QAInsights QAInsights commented Sep 13, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • SETUP.md documents mvn clean verify but never mvn install, so the
    Registry's SNAPSHOT dependency on sourcelume-spec is unresolvable for a
    contributor following the guide literally. Adds the missing step.

Notes

  • Verified the documented setup end-to-end on Linux (Omarchy/Arch):
    uv sync --extra dev, tools/validate.py, python -m unittest discover -s tests (3 pass), and mvn -B verify (RAT + Spotless +
    Checkstyle) all succeed from a clean checkout.
  • mvn install correctly publishes 0.0.1-SNAPSHOT to ~/.m2 — the step
    SETUP.md was missing for Registry development.
  • Caveat: tools/validate.py exits 0 vacuously because examples/ is
    not yet on main — the toolchain works, but no records are validated.

Apache-ai: Yes
Generated-by: Devin (SWE-2 High)
Reviewed-by: nkn

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
@jgoodyear
jgoodyear merged commit b9ad844 into apache:main Sep 13, 2026
@jgoodyear

Copy link
Copy Markdown
Contributor

Thank you NKN :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants