Skip to content

docs(dev/release): Document crates.io, PyPI, and verification pitfalls - #1182

Merged
jiayuasu merged 3 commits into
mainfrom
docs/release-readme-notes
Aug 23, 2026
Merged

docs(dev/release): Document crates.io, PyPI, and verification pitfalls#1182
jiayuasu merged 3 commits into
mainfrom
docs/release-readme-notes

Conversation

@jiayuasu

Copy link
Copy Markdown
Member

What changes are included in this PR?

Release-manager notes from the 0.4.1 release, added to dev/release/README.md:

  • Verification: the Python comparison tests connect to PostGIS on localhost:5432; start the pinned docker compose service and make sure no other PostgreSQL is listening there.
  • GitHub release notes: use the previous release tag as the comparison base (the patch-release text referenced a .dev tag that does not exist).
  • PyPI: pure-Python packages use Metadata-Version 2.5 and need twine>=7; ~/.pypirc must list pypi in index-servers; use --skip-existing for resumable uploads.
  • crates.io: fix the script name (publish-crates.sh), publish from the release tag with the s2geography submodules initialized, list the dev-dependency cycles that must be removed locally, the GDAL_VERSION=3.12.0 workaround for GDAL 3.13, and adding the committers team as owner of new crates.

Are these changes tested?

Documentation only; pre-commit passes.

Are there any user-facing changes?

No.

@github-actions
github-actions Bot requested a review from zhangfengcdt August 22, 2026 04:51

@paleolimbot paleolimbot left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you!

Comment thread dev/release/README.md Outdated
Comment thread dev/release/README.md
Comment on lines +282 to +288
`cargo publish` resolves `[dev-dependencies]` that carry a version requirement, so
dev-dependencies that form a cycle with a crate published later must be removed from
the local checkout before publishing (do not commit these changes). As of 0.4.1 these are
`sedona-testing` in `sedona-geometry`, `sedona-gdal`, `sedona-geo-generic-alg`,
`sedona-raster`, `sedona-expr`, and `sedona-functions`; `sedona-proj` in
`sedona-functions`; and `sedona` in `sedona-pointcloud`, `sedona-tg`, `sedona-geos`,
`sedona-geoarrow-c`, and `sedona-s2geography`.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is a bit of a hack and we're actively working on fixing this (I should have put the issue reference to #1025 and #702 ). I think in general this is frowned upon (modifying sources after a release vote / tag).

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Agreed that it is a hack. I reworded the paragraph to reference #702 and #1025 and to frame this as a stopgap until the cycles are removed, with the note that the modifications are local-only and the published crate contents are otherwise identical to the voted release. Happy to drop the paragraph entirely once #1025 lands.

jiayuasu and others added 2 commits August 22, 2026 23:03
Co-authored-by: Dewey Dunnington <dewey@dunnington.ca>
@jiayuasu
jiayuasu merged commit 4743506 into main Aug 23, 2026
4 checks passed
@jiayuasu
jiayuasu deleted the docs/release-readme-notes branch August 23, 2026 07:10
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.

2 participants