Repository navigation
docs: add a versioning and API compatibility policy - #319
Conversation
Keep datafusion-spark on 56.x until DataFusion 57.0.0 is released, and release 56.x minor and patch versions from main in the meantime, so new functions and fixes ship without waiting for DataFusion. Spell out what counts as a breaking API change, which has to wait for the next DataFusion major version, and how to check for one with cargo-semver-checks. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
@comphead @mbutrovich @shehabgamin moving this code to a new repo means that we can actually release |
mbutrovich
left a comment
There was a problem hiding this comment.
I think this versioning policy makes sense. Let's see if we run into hiccups. Thanks @andygrove!
|
Two follow-ups on the API compatibility section:
|
Which issue does this PR close?
Part of #56. It replaces that issue's plan to make 57.0.0 the first release from this repository.
Rationale for this change
New Spark-compatible functions and fixes land here between DataFusion major releases. Tying
datafusion-sparkreleases to DataFusion's would hold them back, so this PR proposes releasing 56.x frommainas often as needed, until DataFusion 57.0.0 is released. That only works ifmaindoesn't break the public API in the meantime, so the policy spells out what counts as a breaking change.What changes are included in this PR?
dev/release/README.md: expands the Versioning section.mainstays on DataFusion 56 and releases 56.x until DataFusion 57.0.0 is released. Then it moves to DataFusion 57, and its next release is 57.0.0.datafusion-spark56.0.0 frombranch-56in apache/datafusion. Later 56.x releases come from this repository, so a DataFusion 56.x patch release should not publishdatafusion-sparkagain.#[deprecated]. A change to a function's results that makes it match Spark counts as a bug fix.cargo-semver-checks.CONTRIBUTING.md: a short "API Compatibility" section for contributors that links to the policy.Are these changes tested?
Documentation only. To check that the policy can be applied today, I ran
cargo semver-checks -p datafusion-spark --all-featuresagainst the crate at apache/datafusion's56.0.0-rc1tag. Results:mainSince rc1,
mainhas only added public items, such asdaynameanddate_from_unix_date.Are there any user-facing changes?
No code changes.
The policy needs agreement with apache/datafusion: its
branch-56release process still runscargo publishfordatafusion-spark, so DataFusion 56.x patch releases would need to stop publishing it after 56.0.0.This PR was written by an LLM (Claude) and reviewed before opening.
🤖 Generated with Claude Code