Skip to content

docs: fix the server build command - #3485

Open
tommyquak wants to merge 1 commit into
apache:masterfrom
tommyquak:docs-server-build-command
Open

tommyquak wants to merge 1 commit into
apache:masterfrom
tommyquak:docs-server-build-command

Conversation

@tommyquak

@tommyquak tommyquak commented Nov 20, 2026 •

Copy link
Copy Markdown

Purpose of the PR

The server build command in docs/CONTRIBUTING.md and AGENTS.md uses -pl hugegraph-server -am, which only builds the root and hugegraph-server parent POMs. No server module or distribution is built.

Main Changes

Verifying these changes

  • Trivial rework / code cleanup without any test coverage. (No Need)
  • Already covered by existing tests, such as (please modify tests here).
  • Need tests and can be verified as follows:
    • xxx

Ran both commands on master (JDK 17, Maven 3.10.0): the old one builds 2 projects, the new one builds 20 and produces hugegraph-server/apache-hugegraph-server-1.8.0.

Does this PR potentially affect the following parts?

Documentation Status

  • Doc - TODO: required documentation is pending; complete it before merging.
  • Doc - Done: documentation is included here or linked below.
  • Doc - No Need: no user-visible documentation is affected.

The website docs (hugegraph-doc) don't have this command.

- point -pl at hugegraph-server/hugegraph-dist in CONTRIBUTING.md
- make the same change in AGENTS.md
- the old command only built the root and server parent POMs,
  so no server module or distribution was built (Issue 3484)

@bitflicker64 bitflicker64 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocking: no. Score: 9/10. Summary: -pl hugegraph-server/hugegraph-dist -am matches what run-api-test.sh and server-tests.yml build, and the old -pl hugegraph-server -am selects only the root and hugegraph-server parent POMs. At this head, mvn clean package -DskipTests -pl hugegraph-server/hugegraph-dist -am on JDK 17 builds all 20 reactor projects and produces hugegraph-server/apache-hugegraph-server-1.8.0 with the core, api, rocksdb, hbase and hstore jars.

@imbajin imbajin left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Score: 9.0/10 · Confidence: high

Blocking: no

Summary

The distribution selector builds the server modules and their reactor dependencies; no new issues found.

Evidence

The distribution POM declares the server modules and the existing API test script uses the same project selector. The author and another reviewer report successful builds.

Validation notes

I did not independently run Maven or inspect a freshly built distribution.

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.

[Bug] Documented server build command does not build the server modules

3 participants