Skip to content

docs: add Driver-Server Version Compatibility Matrix - #141

Merged
kesmit13 merged 3 commits into
mainfrom
pavlo/add-compat-matrix
Oct 13, 2026
Merged

kesmit13 merged 3 commits into
mainfrom
pavlo/add-compat-matrix

Conversation

@pmishchenko-ua

@pmishchenko-ua pmishchenko-ua commented Oct 12, 2026 •

Copy link
Copy Markdown
Collaborator

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.py builds the markdown table from docs/src/whatsnew.rst release dates, the python-version matrix 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-matrix and --rebuild support CI-style checks and full regeneration.

resources/bump_version.py now runs matrix generation as step 5 (non-fatal on failure), stages COMPATIBILITY.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.

@kesmit13 kesmit13 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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.

Comment thread resources/generate_compatibility.py
@kesmit13
kesmit13 merged commit 33c2b99 into main Oct 13, 2026
15 checks passed

This branch was successfully deployed

1 active deployment
Base — 5441827d Deployed Oct 12, 2026 by pmishchenko-ua via test-coverage #543
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.

4 participants