Repository navigation
docs: add Driver-Server Version Compatibility Matrix - #141
Merged
Merged
Conversation
pmishchenko-ua
requested review from
kesmit13,
mgiannakopoulos and
volodymyr-memsql
as code owners
October 12, 2026 13:13
volodymyr-memsql
approved these changes
Oct 13, 2026
There was a problem hiding this comment.
🟡 Changes recommended
The matrix is presented as proof of compatibility although its engine data only represents lifecycle overlap.
1 open finding
What changed in this PR
Adds generated driver, server lifecycle, and Python testing information to release documentation.
Changes:
- Adds compatibility-matrix generation and verification tooling.
- Integrates generation into the release workflow.
- Publishes and links the generated matrix.
| File | Description |
|---|---|
resources/generate_compatibility.py |
Generates and verifies the matrix. |
resources/bump_version.py |
Integrates matrix generation into releases. |
COMPATIBILITY.md |
Publishes generated lifecycle/testing data. |
README.md |
Links users to the matrix. |
CONTRIBUTING.md |
Documents matrix maintenance. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Note
Low Risk
Documentation and release-script changes only; no runtime driver behavior is modified.
Overview
Adds a published driver–server–Python compatibility matrix (
COMPATIBILITY.md) and tooling to keep it current across releases.resources/generate_compatibility.pybuilds the markdown table fromdocs/src/whatsnew.rstrelease dates, thepython-versionmatrix in each tag’s.github/workflows/smoke-test.yml(or the working tree for the unreleased version), SingleStore’s EOL policy page for engine support windows, and optionally the latest engine RC for the version being prepared. Existing table rows are preserved on incremental runs;--verify-matrixand--rebuildsupport CI-style checks and full regeneration.resources/bump_version.pynow runs matrix generation as step 5 (non-fatal on failure), stagesCOMPATIBILITY.md, and documents the flow in CONTRIBUTING.md. README.md links to the matrix for users choosing driver/server/Python combinations.Reviewed by Cursor Bugbot for commit 5441827. Bugbot is set up for automated code reviews on this repo. Configure here.