docs: add SeaTunnel Source and Sink quick start by zhupitertop · Pull Request #464 · apache/hugegraph-doc

zhupitertop · 2026-08-06T14:33:51Z

Purpose

Add a Chinese quick-start for the HugeGraph connector in Apache SeaTunnel, based on the current SeaTunnel Next documentation and dev code.

What changed

Add a copy-pasteable single-node flow for importing vertices and edges into HugeGraph.
Document HugeGraph Source reads and HugeGraph-to-HugeGraph vertex/edge migration.
Explain bounded reads, at-least-once writes, schema handling, and ID-preservation limits.
Add a Chinese Source/Sink data-flow diagram and a toolchain entry.
Remove the unrelated release workflow and obsolete generated images from this PR.

This PR intentionally updates the Chinese documentation only. The Source and refactored Sink behavior described here follows SeaTunnel dev at 0a5ceee2018e44659593fc16ad57f154a4483210; released versions may differ.

Visual comparison

Before:

After:

The rendered page was also checked at desktop and 375 px widths, with no console errors or horizontal overflow.

Validation

hugo --minify
git diff --check
Markdown fence and link checks
Independent final review: 9.3/10, no Critical or Important findings

References: HugeGraph Source · HugeGraph Sink · local deployment

Bumped default release version to 1.7.0 and updated default GPG user in the release workflow. Added installation step for subversion on Ubuntu. Appended WARP.md to .gitignore.

Deleted validate-release-in-local.sh and enhanced validate-release.sh to support both SVN and local directory validation. Added color-coded output, improved argument handling, and included Java version checks for better usability and error reporting.

Major rewrite of validate-release.sh for Apache HugeGraph, adding modular structure, improved logging, error/warning collection, colorized output, and comprehensive validation steps for source and binary packages. New features include dependency checks, GPG key management, license compliance, file size and binary checks, version consistency, and automated server/toolchain testing. Usage instructions and help output are expanded for clarity.

…s V3 Updated CI workflow to support additional OS and architectures (arm64, macOS 14). Improved documentation and script usage instructions. The license header check now covers more file types and excludes generated/vendor files. Maven build commands in docs and scripts now use '-DskipTests' and '-Dcheckstyle.skip=true' for consistency. Added a detailed README for the release validation script.

Adds contextual error and warning reporting with step and package information, enhances license category and header checks, improves version consistency logic, and refines summary output with execution time and clearer formatting. These changes make validation results more actionable and easier to interpret, especially for multi-package and multi-step validations.

The JSON license was added to the CATEGORY_X regex in the binary package validation step to ensure packages with this license are properly flagged during release validation.

[pull] master from apache:master

* chore: update release workflow and .gitignore entries Bumped default release version to 1.7.0 and updated default GPG user in the release workflow. Added installation step for subversion on Ubuntu. Appended WARP.md to .gitignore. * refactor: unify release validation script and add local path support Deleted validate-release-in-local.sh and enhanced validate-release.sh to support both SVN and local directory validation. Added color-coded output, improved argument handling, and included Java version checks for better usability and error reporting. * refactor: revamp release validation script with enhanced checks V2 Major rewrite of validate-release.sh for Apache HugeGraph, adding modular structure, improved logging, error/warning collection, colorized output, and comprehensive validation steps for source and binary packages. New features include dependency checks, GPG key management, license compliance, file size and binary checks, version consistency, and automated server/toolchain testing. Usage instructions and help output are expanded for clarity. * refactor: enhance release validation for multi-arch and license checks V3 Updated CI workflow to support additional OS and architectures (arm64, macOS 14). Improved documentation and script usage instructions. The license header check now covers more file types and excludes generated/vendor files. Maven build commands in docs and scripts now use '-DskipTests' and '-Dcheckstyle.skip=true' for consistency. Added a detailed README for the release validation script. * refactor: improve validation script error context and reporting V4 Adds contextual error and warning reporting with step and package information, enhances license category and header checks, improves version consistency logic, and refines summary output with execution time and clearer formatting. These changes make validation results more actionable and easier to interpret, especially for multi-package and multi-step validations. * fix: add JSON to CATEGORY_X license validation The JSON license was added to the CATEGORY_X regex in the binary package validation step to ensure packages with this license are properly flagged during release validation. * introduce new version of validation * Update GPG username and regex in workflow --------- Co-authored-by: imbajin <jin@apache.org>

…#415) * fixed mvn version to 1.7.0 added graphspace part for docs of client changed client examples to NEWER version fixed parameters in loader docs

[pull] master from apache:master

docs: add Apache SeaTunnel connector integration guide (CN only) Add HugeGraph-SeaTunnel Connector documentation as an ecosystem entry point for users who want to sync data between HugeGraph and external systems via Apache SeaTunnel. Changes: - Add CN SeaTunnel connector doc in quickstart/toolchain/ - Add SeaTunnel to toolchain table and architecture diagram in CN introduction page - Follow existing Spark-connector documentation style and structure Co-Authored-By: Claude <noreply@anthropic.com> @

imbajin

Blocking: yes. Summary: The PR adds an unrelated release workflow that uses obsolete artifact rules, and its SeaTunnel guide contains unsupported claims and non-runnable configuration. Evidence: actionlint /tmp/validate-release-new-464.yml; exact-head patch; and comparison with the parent release workflow.

imbajin

Blocking: yes. Summary: The new release workflow still fails valid artifacts or validates them incompletely, and the SeaTunnel documentation has unsupported compatibility and reference claims. Evidence: exact-head workflow/source review, actionlint, macOS grep reproduction, and current Apache documentation checks at 4ae78ff.

imbajin

Blocking: yes. Summary: The new source-package license validation still has fail-open gaps that can let unreviewed files pass. Evidence: exact-head static review of validate-release-new.yml at 4ae78ff.

docs: add SeaTunnel integration architecture diagrams Add GPT-generated illustrations for the SeaTunnel Connector documentation: - Architecture diagram: HugeGraph + SeaTunnel data integration overview - Source/Sink diagram: bidirectional data flow between HugeGraph and external systems - Full-stack ecosystem diagram: complete HugeGraph toolchain visualization Placed in connector doc and introduction page for visual enhancement. Co-Authored-By: Claude <noreply@anthropic.com> @

docs: fix PR review issues for SeaTunnel connector doc Address reviewer feedback: - B1: Fix SeaTunnel installation link (/docs/start-v2/ -> /docs/getting-started/) - B2: Replace fake config params (url/graph/label) with real connector parameters (host/port/graph_name/mappings) from SeaTunnel docs - C: Add version compatibility matrix, note Source connector is dev-only - D: Add English docs synchronization (connector doc + introduction page) - E: Fix ASCII diagram border alignment (all lines now 70 chars wide) Co-Authored-By: Claude <noreply@anthropic.com> @

imbajin

Blocking: yes. Summary: The Chinese introduction page contains an unmatched fenced code block, so the rest of the page can render as code and its navigation/content is broken. Evidence: exact-head source has five triple-backtick fences with the extra opener at line 41; the latest deploy check is green but does not catch this Markdown structure.

docs: remove EN files, keep CN only for review Revert English docs to original state; Chinese version will be reviewed first before adding English back. Co-Authored-By: Claude <noreply@anthropic.com> @

fix: remove orphaned ```text fence in CN introduction The unmatched ```text opener at line 41 caused all subsequent content to render as a code block, breaking navigation and page rendering. Co-Authored-By: Claude <noreply@anthropic.com> @

fix: correct version matrix and connector doc link - Java: 8+ -> 11+ (HugeGraph Client 1.5.0+ requires Java 11) - SeaTunnel: 2.3.12+ -> 2.3.13+ (bundles HugeGraph Client 1.5.0) - HugeGraph Server: 1.0.0+ -> 1.5.0+ (match client version in connector) - Link: generic /docs/connector-v2/ -> specific HugeGraph Sink page Co-Authored-By: Claude <noreply@anthropic.com> @

- add a single-node import walkthrough with verification - document HugeGraph Source reads and graph clone flows - align examples and limits with SeaTunnel dev - remove unrelated workflow and obsolete assets

imbajin

Final review on a136574: +1. The final diff is scoped to the Chinese SeaTunnel guide and its diagram, aligns the Source/Sink examples with current Next/dev behavior, documents the cross-graph ID constraints, and passes the Hugo build. Independent review score: 9.3/10, with no Critical or Important findings.

imbajin and others added 20 commits November 15, 2025 00:59

chore: update release workflow and .gitignore entries

62baf2a

Bumped default release version to 1.7.0 and updated default GPG user in the release workflow. Added installation step for subversion on Ubuntu. Appended WARP.md to .gitignore.

fix: add JSON to CATEGORY_X license validation

af87f8a

The JSON license was added to the CATEGORY_X regex in the binary package validation step to ensure packages with this license are properly flagged during release validation.

introduce new version of validation

512b51c

Update GPG username and regex in workflow

c4107b6

feat: add 1.7.0 release-notes (apache#429)

c773933

chore: add docker using / add load data methods (apache#423)

dff6ba1

chore: minor test (apache#430)

ea90243

docs: delete licsence/add link of twitter (apache#431)

e4660a6

chore: add deepwiki notes in docs (apache#432)

34bfab5

Merge pull request #24 from apache/master

13b6d1f

[pull] master from apache:master

Merge branch 'apache:master' into master

966a459

feat: 1.7.0 download-links (apache#434)

b55fe2b

docs: refactor docs of loader & client for new version(1.7.0) (apache…

d533820

…#415) * fixed mvn version to 1.7.0 added graphspace part for docs of client changed client examples to NEWER version fixed parameters in loader docs

Merge pull request #29 from apache/master

90f21e5

[pull] master from apache:master

Merge pull request #30 from apache/master

51e334f

[pull] master from apache:master

dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. enhancement New feature or request labels Aug 6, 2026

zhupitertop force-pushed the add-seatunnel-integration-doc branch from cf93179 to 4ae78ff Compare August 6, 2026 15:24

dosubot Bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Aug 6, 2026

imbajin reviewed Aug 6, 2026

View reviewed changes

imbajin reviewed Aug 7, 2026

View reviewed changes

Comment thread .github/workflows/validate-release-new.yml Outdated

Comment thread .github/workflows/validate-release-new.yml Outdated

dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:M This PR changes 30-99 lines, ignoring generated files. labels Aug 7, 2026

imbajin reviewed Aug 8, 2026

View reviewed changes

Comment thread content/cn/docs/introduction/_index.md Outdated

spr1lng and others added 4 commits August 10, 2026 20:40

@

c886b49

docs: remove EN files, keep CN only for review Revert English docs to original state; Chinese version will be reviewed first before adding English back. Co-Authored-By: Claude <noreply@anthropic.com> @

@

d15c312

fix: remove orphaned ```text fence in CN introduction The unmatched ```text opener at line 41 caused all subsequent content to render as a code block, breaking navigation and page rendering. Co-Authored-By: Claude <noreply@anthropic.com> @

docs: add SeaTunnel Source and Sink guide

a136574

- add a single-node import walkthrough with verification - document HugeGraph Source reads and graph clone flows - align examples and limits with SeaTunnel dev - remove unrelated workflow and obsolete assets

imbajin changed the title ~~Add seatunnel integration doc~~ docs: add SeaTunnel Source and Sink quick start Aug 11, 2026

imbajin approved these changes Aug 11, 2026

View reviewed changes

dosubot Bot added the lgtm This PR has been approved by a maintainer label Aug 11, 2026

Uh oh!

Conversation

zhupitertop commented Aug 6, 2026 • edited by imbajin Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

What changed

Visual comparison

Validation

Uh oh!

imbajin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

imbajin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

imbajin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

imbajin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

imbajin left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

zhupitertop commented Aug 6, 2026 •

edited by imbajin

Loading