Skip to content

[ISSUE #8419] Correct java client migration contribution guidance - #8459

Merged
Aias00 merged 1 commit into
apache:masterfrom
fusenning119:codex/8419-client-contribution-guide
Nov 13, 2026
Merged

Aias00 merged 1 commit into
apache:masterfrom
fusenning119:codex/8419-client-contribution-guide

Conversation

@fusenning119

Copy link
Copy Markdown
Contributor

Fixes #8419.

Problem and change

The contribution guide still treated the historical external Java 8 / Spring Boot 2 implementation as the baseline for new migration work. It also described client-local protocol ownership and a compatibility matrix as future work, while the accepted policy already targets Java 17 / Boot 3 and main-owned protocol/foundation artifacts.

  • Separate historical maintenance, main's in-tree clients and the external migration candidate using pinned POMs and the applicable branch/issue. Align build commands, foundation preparation, Java 21 verification and PR checklists with the existing migration policy.
  • Link the existing compatibility matrix and release gates. Distinguish local source checks, hosted CI and published support; retain beat and its starter in main, keep SDK modules outside the split, and make source removal conditional on the existing release gates.
  • Correct the adjacent examples README: these examples use main's staged client modules through ${project.version}; the former shenyu.client.java.version override no longer selects external artifacts. Document the separate example reactor and the required build order.

External candidate #16 remains draft and unmerged at head a37668298edef5c501e8b56a0595ed50ef895656 as checked on 2026-11-12. This documentation correction is independently deliverable and does not depend on merging or publishing that candidate. No production code, POM, CI configuration or supported-release policy changes.

IssueSpec

IssueSpec-Mode: lightweight
IssueSpec-Reason: Correct two documentation entry points to match existing Java client migration, ownership and compatibility policy without changing behavior or support claims.
IssueSpec-Validation: Pinned POM/workflow and current PR checks, links and shell syntax passed. Java 17 full local install passed: 216 modules, 9,545 tests including 21 skipped, zero failures/errors, with Checkstyle and RAT. MCP/Spring MVC example builds and MCP dependency checks passed. External candidate Java 17/21 builds, main Java 21 full build and manual registration/routing scenarios were not run.

Validation

  • ./mvnw clean install -Dmaven.javadoc.skip=true — passed with Temurin 17.0.21+9 and Maven Wrapper 3.6.3; 216 modules, 9,545 tests (21 skipped), 0 failures/errors; Checkstyle and RAT passed.
  • ./mvnw install -pl shenyu-spring-boot-starter/shenyu-spring-boot-starter-client/shenyu-spring-boot-starter-client-mcp,shenyu-spring-boot-starter/shenyu-spring-boot-starter-client/shenyu-spring-boot-starter-client-springmvc -am -DskipTests -Dmaven.javadoc.skip=true — passed; dependency preparation, tests skipped.
  • ./mvnw -f shenyu-examples/pom.xml install -pl shenyu-examples-mcp -am -DskipTests and the equivalent command with -pl shenyu-examples-springmvc — passed; tests skipped.
  • ./mvnw -f shenyu-examples/pom.xml dependency:tree -pl shenyu-examples-mcp -Dincludes=org.apache.shenyu:* — passed; client/starter dependencies resolve to this checkout's 2.7.3-SNAPSHOT, without historical JDK8 or migration-candidate artifacts.
  • Checked 19 internal links/anchors, 13 external links, and 14 shell blocks with bash -n; git diff --check passed.
  • Cross-checked historical/candidate POMs and candidate commands against pinned workflows/preparation scripts, plus existing compatibility, ownership and release documents. These factual checks do not claim candidate runtime execution or new release certification.

Make sure that:

  • You have read the contribution guidelines.
  • You submit test cases (unit or integration tests) that back your changes. Not applicable: documentation-only correction; factual, link and command checks are listed above.
  • Your local test passed ./mvnw clean install -Dmaven.javadoc.skip=true.

@Aias00 Aias00 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.

Stream Agent analysis

Documentation-only correction of Java client migration contribution guidance. PR #8459 (head 7cccf6b) updates docs/split-client-contribution.md and shenyu-examples/README.md to align with the accepted Java 17/Boot 3, main-owned protocol/foundation policy, replacing the historical Java 8/Boot 2 split-client baseline. Full diff (40683 chars) read across all pages; CI complete and passing; referenced anchor docs and the POM property claim were verified.

Evidence

  • Full VERSIONED_DIFF read end-to-end: resource_diff offset 0..40683 with has_more=false; only docs/split-client-contribution.md (+215/-134) and shenyu-examples/README.md (+77/-97) changed, no source/test changes.
  • Frozen CI evidence: complete=true, passed=true; checks issue-spec-policy, policy (8459), discover all success; no failed checks.
  • Verified factual claims: head shenyu-examples/pom.xml is 2.7.3-SNAPSHOT / spring-boot-starter-parent 3.3.1 with no shenyu.client.java.version property (matches 'no longer used by this POM'); referenced java-client-compatibility.md, java-client-repository-boundary.md and CLIENT_MIGRATION.md all exist in head.

Recommended next steps

Scope: captured diff and GitHub check metadata only; no local tests were executed.

Task: 74c81661-3c87-49ac-9771-577a976168ef · Commit: 7cccf6b620f67bbeab66d92faa777e7ee46aabad

Review verdict: PASS

Whole-PR review with complete diff coverage, passing CI (3/3 checks success), and verified factual/anchor references. The change is documentation-only (no code/tests) and correctly corrects the contribution guide to the accepted Java 17/Boot 3, main-owned protocol/foundation policy; no concrete HIGH/CRITICAL defect found. External commit hashes and dated 'source state' notes are forward-looking guidance not falsifiable within repo evidence but are internally consistent with the migration policy.

Publication: APPROVE (EXPLICIT_PASS)

@Aias00 Aias00 added this to the 2.7.3 milestone Nov 13, 2026
@Aias00
Aias00 merged commit 00cb35a into apache:master Nov 13, 2026
29 checks passed
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.

[Task][Java Client] Correct the remaining Java 8 migration guidance in the contribution guide

2 participants