Skip to content

Version compatibility table: umbrella ↔ core/s3/connector pairing is undiscoverable without reading release notes #254

Description

@jeronimodeleon

Summary

Follow-up to #244 and #250. The immediate confusion (wave tags being mistaken for genblaze PyPI versions) is documented now: README/PyPI callouts, and durable warnings on the affected CHANGELOG wave headers. What's still open is the discoverability gap both issues asked for: nothing today tells a consumer, at a glance, which genblaze-core / genblaze-s3 / connector versions a given umbrella version actually pairs with, short of reading release notes.

Current state

genblaze==0.4.0 ships with genblaze-core==0.3.2 and genblaze-s3==0.3.2. An agent pinning genblaze==0.3.2 from public PyPI gets genblaze-core==0.2.8 — the floor pin in that older umbrella. Not a republish problem; a discoverability problem: the pairing is only recoverable by reading that wave's CHANGELOG entry.

Gate 1 — verification (do this first)

In a clean venv: pip install genblaze==0.3.2, then import the package, build a trivial manifest, and reload it.

  • If install + smoke succeeds, continue with the docs-only approach below.
  • If install or smoke fails, this escalates to a yank/republish decision, and the approach below no longer applies as scoped.

Proposed approach (after Gate 1 passes)

  • Add a "Version compatibility" section to README.md with a small table mapping umbrella wave → genblaze-coregenblaze-s3 → provider connector floors.
  • Add the same clarifying paragraph to each package's PyPI long_description via the readme field in pyproject.toml (not description, which is a single-line ≤512-char summary and won't render Markdown). Verify rendering with twine check dist/* against a locally built wheel before publish.

References

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions