Skip to content

docs(hugegraph): declare distributed limits in README - #3415

Merged
weicao merged 1 commit into
dev/hugegraph-release-1.0from
feat/hugegraph-readme-distributed
Aug 18, 2026
Merged

docs(hugegraph): declare distributed limits in README#3415
weicao merged 1 commit into
dev/hugegraph-release-1.0from
feat/hugegraph-readme-distributed

Conversation

@weicao

@weicao weicao commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Summary

Child PR into dev/hugegraph-release-1.0 for 12a restriction text after #3414 landed.

distributed is a declared topology. Standalone still owns checkpoint backup/restore. Distributed backup/restore, Store scale-in/rebalance, roleProbe/switchover, reconfigure, and TLS stay unsupported.

Changes

  • README capability table covers both topologies
  • Explicit "not supported" for distributed BR and Store scale-in
  • BackupPolicyTemplate remains standalone-server-only, and README says so
  • DESIGN.zh.md points distributed design at DESIGN-distributed.zh.md
  • contract_test.sh asserts the restriction sentences

Contract

docs/addon-api/12a-minimum-acceptance.md: every declared topology needs independent acceptance or a restriction statement.
docs/addon-api/12b-claimed-only-acceptance.md: unclaimed capabilities must not be written as supported.

Test

bash addons/hugegraph/tests/contract_test.sh
HugeGraph addon offline contracts passed

Main PR: #3412

Record the distributed topology next to standalone and mark backup,
store scale-in, roleProbe, reconfigure, and TLS as unsupported.
Keep BackupPolicyTemplate scoped to standalone server.
@weicao
weicao requested review from a team and leon-ape as code owners August 18, 2026 18:16
@weicao
weicao merged commit 754d5d6 into dev/hugegraph-release-1.0 Aug 18, 2026
7 checks passed
@weicao
weicao deleted the feat/hugegraph-readme-distributed branch August 18, 2026 18:20
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 0.00%. Comparing base (4069790) to head (530fc72).
⚠️ Report is 1 commits behind head on dev/hugegraph-release-1.0.

Additional details and impacted files
@@                    Coverage Diff                    @@
##           dev/hugegraph-release-1.0   #3415   +/-   ##
=========================================================
  Coverage                       0.00%   0.00%           
=========================================================
  Files                             69      69           
  Lines                           7275    7275           
=========================================================
  Misses                          7275    7275           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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