Add seatunnel integration doc by zhupitertop · Pull Request #464 · apache/hugegraph-doc

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

Purpose of the PR

Add Apache SeaTunnel connector integration documentation as an ecosystem entry point
Users can now discover HugeGraph's SeaTunnel Connector-V2 support for data synchronization

Changes

New: content/cn/docs/quickstart/toolchain/hugegraph-seatunnel-connector.md — Chinese SeaTunnel integration doc
New: content/en/docs/quickstart/toolchain/hugegraph-seatunnel-connector.md — English SeaTunnel integration doc
Modified: content/cn/docs/introduction/_index.md — Add SeaTunnel to toolchain table & architecture diagram
Modified: content/en/docs/introduction/_index.md — Add SeaTunnel to toolchain table & architecture diagram (EN)

Background

The HugeGraph community has contributed HugeGraph Connector-V2 to Apache SeaTunnel, which is now in the merge pipeline. This PR adds the ecosystem entry in the official HugeGraph documentation so users know HugeGraph supports Apache SeaTunnel for data synchronization.

Doc Preview

New SeaTunnel Doc (CN)

![seatunnel-cn-doc]

Introduction Page — Toolchain Table (CN)

Before: Hubble | Loader | Client | Spark-connector | Tools
After: Hubble | Loader | Client | Spark-connector | SeaTunnel-connector | Tools

New SeaTunnel Doc (EN)

![seatunnel-en-doc]

Introduction Page — Toolchain Table (EN)

Before: Hubble | Loader | Client | Spark-connector | Tools
After: Hubble | Loader | Client | Spark-connector | SeaTunnel-connector | Tools

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 · 2026-08-06T18:46:02Z

@@ -0,0 +1,805 @@
+name: "Validate Apache Release (New)"


⚠️ important — This PR is scoped as a SeaTunnel documentation change, but it adds an 805-line release-validation workflow with active release-* push/pull_request triggers. Please remove it from this PR and review it separately; otherwise unrelated CI behavior is merged without focused validation.

imbajin · 2026-08-06T18:46:02Z

+      RELEASE_VERSION: ${{ inputs.release_version || '1.7.0' }}
+      GPG_USER: ${{ inputs.gpg_user || 'pengjunzhi' }}
+      JAVA_VERSION: ${{ inputs.java_version || matrix.java_version || '11' }}
+      SVN_URL_PREFIX: https://dist.apache.org/repos/dist/dev/incubator/hugegraph


‼️ critical — Both Apache endpoints still use the retired incubator layout (dist/dev/incubator/hugegraph and downloads.apache.org/incubator/hugegraph/KEYS). The parent workflow uses the post-graduation /hugegraph/ paths, so this workflow cannot fetch current release material. Replace both URLs with the TLP paths.

imbajin · 2026-08-06T18:46:02Z

+            pushd "$PACKAGE_DIR"
+
+            # 5.1: Check incubating name
+            if [[ ! "$src_pkg" =~ "incubating" ]]; then


‼️ critical — The workflow requires incubating in source and binary names and checks incubator-shaped directories (also at line 631), while the parent workflow rejects that naming for current TLP artifacts. Valid packages will therefore be rejected or not found. Port the post-graduation naming/glob rules and remove the mandatory DISCLAIMER checks.

imbajin · 2026-08-06T18:46:02Z

+      - 'release-*'
+
+jobs:
+  validate:


⚠️ important — This job downloads, extracts, compiles, and executes release-candidate code, but declares no job permissions and leaves checkout credentials enabled by default. Add permissions: contents: read and persist-credentials: false so candidate code cannot inherit broader repository access.

imbajin · 2026-08-06T18:46:02Z

+          echo "Step [2/9]: Prepare Release Files"
+          echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+
+          DIST_DIR="dist/${{ env.RELEASE_VERSION }}"


⚠️ important — Workflow inputs are interpolated directly into generated shell text (${{ env.RELEASE_VERSION }} and GPG_USER usages below). A value containing shell syntax can execute before the script's quoted variables are applied. Pass values through the process environment, quote "$RELEASE_VERSION"/"$GPG_USER", and validate them against strict allowlists.

imbajin · 2026-08-06T18:46:02Z

+
+#### 4.1 安装 SeaTunnel
+
+请参考 [Apache SeaTunnel 安装指南](https://seatunnel.apache.org/docs/start-v2/) 完成 SeaTunnel 的部署。


⚠️ important — The installation link points to /docs/start-v2/, which is not the current deployment guide, and the page says the connector can be referenced directly although current SeaTunnel deployments require connector-plugin installation. Link the current deployment guide and document the required plugin installation step.

imbajin · 2026-08-06T18:46:02Z

+```hocon
+source {
+  HugeGraph {
+    url = "http://127.0.0.1:8080"


⚠️ important — The Source example uses url and graph, which are not the documented connection fields, and omits required connection parameters such as host, port, and graph_name. Provide a versioned, runnable Source example only if that Source implementation is released; otherwise remove it.

imbajin · 2026-08-06T18:46:02Z

+```hocon
+sink {
+  HugeGraph {
+    url = "http://127.0.0.1:8080"


⚠️ important — The Sink example uses unsupported url/graph fields and omits required host, port, graph_name, and schema_config, so it cannot run. Replace it with a complete versioned example using the official HugeGraph Sink options and state that the HugeGraph schema must already exist.

imbajin · 2026-08-06T18:46:02Z

 | [Loader](/cn/docs/quickstart/toolchain/hugegraph-loader) | 数据导入工具：支持本地文件、HDFS、MySQL 等多数据源，TXT/CSV/JSON 等格式 |
 | [Client](/cn/docs/quickstart/client/hugegraph-client) | 多语言 SDK：Java / Python / Go |
 | [Spark-connector](/cn/docs/quickstart/toolchain/hugegraph-spark-connector) | Spark 集成：支持通过 Spark 批量读写图数据，适合大数据离线处理场景 |
+| [SeaTunnel-connector](/cn/docs/quickstart/toolchain/hugegraph-seatunnel-connector) | SeaTunnel 集成：支持通过 SeaTunnel 在 HugeGraph 与外部数据系统之间同步数据 |


⚠️ important — The patch adds only the Chinese quick-start and introduction entry, while the repository maintains parallel content/cn and content/en documentation. Add the corresponding English page and content/en/docs/introduction/_index.md entry so the integration is discoverable on both sites.

imbajin · 2026-08-06T18:46:02Z

 ├──────────────────┴────────────────────┴──────────────────────┤
 │                    HugeGraph Toolchain                       │
-│  Hubble | Loader | Client(Java/Go/Py) | Spark | Tools        │
+│  Hubble | Loader | Client(Java/Go/Py) | Spark | SeaTunnel | Tools        │


🧹 minor — The new SeaTunnel row is wider than the ASCII diagram's top and bottom borders, so the right edge no longer aligns. Extend the frame or shorten the row and adjust the padding.

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

Navigation Menu

Uh oh!

Add seatunnel integration doc - #464

Add seatunnel integration doc#464
zhupitertop wants to merge 21 commits into
apache:masterfrom
hugegraph:add-seatunnel-integration-doc

zhupitertop commented Aug 6, 2026

Uh oh!

imbajin left a comment

Uh oh!

imbajin Aug 6, 2026

Uh oh!

imbajin Aug 6, 2026

Uh oh!

imbajin Aug 6, 2026

Uh oh!

imbajin Aug 6, 2026

Uh oh!

imbajin Aug 6, 2026

Uh oh!

imbajin Aug 6, 2026

Uh oh!

imbajin Aug 6, 2026

Uh oh!

imbajin Aug 6, 2026

Uh oh!

imbajin Aug 6, 2026

Uh oh!

imbajin Aug 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants


		#### 4.1 安装 SeaTunnel

		请参考 [Apache SeaTunnel 安装指南](https://seatunnel.apache.org/docs/start-v2/) 完成 SeaTunnel 的部署。

Uh oh!

Conversation

zhupitertop commented Aug 6, 2026

Purpose of the PR

Changes

Background

Doc Preview

New SeaTunnel Doc (CN)

Introduction Page — Toolchain Table (CN)

New SeaTunnel Doc (EN)

Introduction Page — Toolchain Table (EN)

Uh oh!

imbajin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants