andygrove opened a new pull request, #1939:
URL: https://github.com/apache/datafusion-ballista/pull/1939
# Which issue does this PR close?
Closes #1938.
# Rationale for this change
Ballista has no per-release upgrade guide. Upstream DataFusion maintains one
under `docs/source/library-user-guide/upgrading/`, giving users a single
authoritative place to learn what breaks and what action to take when moving
between releases. The auto-generated changelog is not a substitute — it lists
merged PRs but does not tell a user what they must change. This PR establishes
the same kind of hand-curated, versioned upgrade guide for Ballista.
# What changes are included in this PR?
- New `docs/source/upgrading/` directory with an `index.rst` toctree, wired
into the top-level docs navigation as an "Upgrade Guides" section.
- A `54.0.0.md` page documenting the **breaking changes** since `53.0.0`.
Because Ballista serves both cluster operators and library/embedding users,
entries are separated by audience:
- **For library and embedding users:** the DataFusion 54 upgrade, and
`job_id` becoming a newtype.
- **For cluster operators:** CORS origins/methods moving from environment
variables to CLI flags.
- **Planner and execution behavior changes:** the static planner now
broadcasting small join build sides (changed defaults), the empty-projection
serialization fix (wire compatibility for mixed-version clusters), and the
opt-in AQE join changes.
- A short note in the contributors guide asking contributors to add an
upgrade-guide entry when they introduce a breaking change, so the guide stays
current release over release.
Scope is deliberately limited to breaking changes (breaking
API/trait/signature changes, removed/renamed config keys or CLI flags, changed
defaults that alter plans/results, and wire/serialization-format changes);
additive features and cosmetic changes are left to the changelog.
# Are there any user-facing changes?
Documentation only — no code changes. Adds a new Upgrade Guides section to
the rendered documentation.
--
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
