Conversation
Add notes to README, hugegraph-store/README, and hugegraph-store/docs/deployment-guide indicating that historical releases (<= 1.7.0) used the "-incubating" suffix in package and directory names.
There was a problem hiding this comment.
Pull request overview
Updates documentation to clarify that some historical HugeGraph releases used -incubating in distribution package/directory names, aiming to reduce confusion when following install/deploy instructions.
Changes:
- Add a
-incubatingnaming note to the root binary download instructions. - Add a similar note to HugeGraph Store’s quickstart run instructions.
- Add similar notes to the Store deployment guide for PD/Store/Server extraction steps.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| README.md | Adds a note about -incubating naming for historical binary packages. |
| hugegraph-store/README.md | Adds a note about -incubating naming for historical Store directories. |
| hugegraph-store/docs/deployment-guide.md | Adds -incubating naming notes to PD/Store/Server extraction steps. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
VGalaxies
left a comment
VGalaxies
left a comment
There was a problem hiding this comment.
The added note points readers at the historical naming change, but hugegraph-store/docs/deployment-guide.md still hardcodes 1.7.0 commands without the -incubating segment. In tag 1.7.0, the documented commands were apache-hugegraph-pd-incubating-1.7.0, apache-hugegraph-store-incubating-1.7.0, and apache-hugegraph-incubating-1.7.0 (matching the 1.7.0 docs and module final.name settings). Because the guide uses concrete 1.7.0 examples, copy-pasting the current commands will still fail. Please either update those sample commands to the actual 1.7.0 names or switch the examples to a non-incubating release.
- update 1.7.0 command examples to use historical incubating package names - clarify current vs historical download and directory naming in docs - fix store README build path to use hg-store-dist - replace hardcoded 1.7.0 paths with version placeholders where appropriate
There was a problem hiding this comment.
Pull request overview
Updates documentation to clarify that historical HugeGraph releases (<= 1.7.0) used the -incubating suffix in package and directory names, and adjusts example commands/paths accordingly.
Changes:
- Add “historical
-incubatingsuffix” notes to multiple guides (deployment/operations/development). - Update example tarball/directory names for 1.7.0 to include
-incubating. - Adjust some build/distribution path examples to use version placeholders.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| hugegraph-store/docs/operations-guide.md | Updates upgrade/rollback examples for 1.7.0 to use -incubating package/directory names. |
| hugegraph-store/docs/development-guide.md | Replaces hardcoded 1.7.0 working directory with version placeholder and notes -incubating for historical releases. |
| hugegraph-store/docs/deployment-guide.md | Updates extract/cd examples for PD/Store/Server 1.7.0 to include -incubating and adds explanatory notes. |
| hugegraph-store/README.md | Updates build module path and distribution path examples; adds note about -incubating for historical releases. |
| README.md | Expands download snippet to document archive URL and PACKAGE naming for historical -incubating releases. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| mvn install -pl hugegraph-struct -am -DskipTests | ||
|
|
||
| # Build Store and all dependencies | ||
| mvn clean package -pl hugegraph-store/hugegraph-store-dist -am -DskipTests | ||
| mvn clean package -pl hugegraph-store/hg-store-dist -am -DskipTests |
| # Follow deployment guide | ||
| tar -xzf apache-hugegraph-store-1.7.0.tar.gz | ||
| cd apache-hugegraph-store-1.7.0 | ||
| # Historical 1.7.0 packages still include the "-incubating" suffix |
| wget ${BASE_URL}/${PACKAGE}.tar.gz | ||
| tar -xzf ${PACKAGE}.tar.gz | ||
| cd ${PACKAGE} |
| - Main class: `org.apache.hugegraph.store.node.StoreNodeApplication` | ||
| - VM options: `-Xms4g -Xmx4g -Dconfig.file=conf/application.yml` | ||
| - Working directory: `hugegraph-store/apache-hugegraph-store-1.7.0` | ||
| - Working directory: `hugegraph-store/apache-hugegraph-store-<version>` (`apache-hugegraph-store-incubating-<version>` for historical 1.7.0 and earlier directories) |
VGalaxies
left a comment
VGalaxies
left a comment
There was a problem hiding this comment.
Follow-up looks good. The historical 1.7.0 package and directory examples now match the actual release artifacts, and the README/store docs are aligned with the current packaging layout.
Add notes to README, hugegraph-store/README, and hugegraph-store/docs/deployment-guide indicating that historical releases (<= 1.7.0) used the "-incubating" suffix in package and directory names.