davidzollo opened a new issue, #10046: URL: https://github.com/apache/seatunnel/issues/10046
## Problem SeaTunnel currently lacks centralized documentation for tracking incompatible changes across versions. Users upgrading from 2.3.x to newer versions must manually search through PRs and release notes to identify breaking changes, increasing upgrade risk and friction. ## Reference Apache DolphinScheduler maintains incompatible changes at: - Path: `docs/docs/en/guide/upgrade/incompatible.md` - URL: https://github.com/apache/dolphinscheduler/blob/dev/docs/docs/en/guide/upgrade/incompatible.md Format example: ```markdown ## 3.3.0 * [MySQL] Upgrade driver from 8.0.16 to 8.2.0 ([#14684](link)) * [API] Remove deprecated API `getTaskInstance()` ([#12345](link)) ``` ## Proposal Create incompatible changes documentation for SeaTunnel: **File Location:** ``` docs/en/concept/incompatible-changes.md docs/zh/concept/incompatible-changes.md ``` **Structure:** ```markdown # Incompatible Changes ## 2.4.x ### API Changes * [Description] ([#PR](link)) ### Configuration Changes * [Description] ([#PR](link)) ### Connector Changes * [Description] ([#PR](link)) ## 2.3.x ... ``` **Sections to cover:** - API changes (interfaces, method signatures) - Configuration changes (removed/modified options) - Connector changes (sources/sinks breaking changes) - Transform changes - Engine behavior changes - Dependency upgrades ## Benefits 1. **Reduced upgrade risk** - Users can assess impact before upgrading 2. **Better user experience** - Quick reference for breaking changes 3. **Production readiness** - Critical for enterprise deployments ## Implementation 1. Create initial documentation structure 2. Backfill changes from recent versions (2.3.x) 3. Add PR template checklist: "Update incompatible-changes.md if needed" 4. Link from release notes -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
