apache / apache/shenyu

[Task] Build a version compatibility matrix for main repo and shenyu-client-java

Open
#6,370 1 comment 0 reactions 0 assignees View on GitHub
status: volunteer wanted
Dominant language
Java
Stars
8.8k
Forks
3.1k
Avg merge
7d 1h
Merged PRs (30d)
85

Description

### Description

## Background

After splitting Java client code into `shenyu-client-java`, users need to know which client versions work with which ShenYu main repo versions and which JDK versions are supported.

We need a documented compatibility matrix.

## Tasks

- [ ] Define client repo version dimensions.
- [ ] Define main repo/admin/bootstrap version dimensions.
- [ ] Define client-side JDK support policy.
- [ ] Define main repo JDK support policy.
- [ ] Identify supported, best-effort, and unsupported combinations.
- [ ] Document compatibility expectations for old client with new admin.
- [ ] Document compatibility expectations for new client with old admin.
- [ ] Add release checklist items for updating the matrix.

## Expected Output

A compatibility matrix document.

## Suggested Matrix Columns

- `shenyu-client-java` version
- ShenYu main repo version
- Client JDK baseline
- Client JDK verified versions
- Admin/bootstrap JDK baseline
- Registration protocol compatibility
- Notes

## Acceptance Criteria

- The matrix distinguishes runtime support from tested support.
- The matrix includes JDK 8, 17, 21, 23, and 25 where appropriate.
- The matrix can be updated during release.

### Task List

_No response_

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the shenyu-client-java and main repository release/version history, including the registration protocol and JDK support expectations. Produce the compatibility matrix covering the requested versions and support categories, then add release checklist guidance so the matrix can be updated with each release.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation, release
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.