This is an automated email from the ASF dual-hosted git repository.
paleolimbot pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/sedona-db.git
The following commit(s) were added to refs/heads/main by this push:
new 1c812079 chore(dev/release): Update release instructions following
0.2.0 release (#429)
1c812079 is described below
commit 1c812079ab467779b6d8fd84a540b364aac99787
Author: Dewey Dunnington <[email protected]>
AuthorDate: Thu Dec 11 20:44:58 2025 -0600
chore(dev/release): Update release instructions following 0.2.0 release
(#429)
---
dev/release/README.md | 118 +++++++++++++++++++++++++++++++++++++++++++++++---
1 file changed, 113 insertions(+), 5 deletions(-)
diff --git a/dev/release/README.md b/dev/release/README.md
index 1a5100e4..6124432a 100644
--- a/dev/release/README.md
+++ b/dev/release/README.md
@@ -65,6 +65,26 @@ environment variable may be set.
export MATURIN_PEP517_ARGS="--features s2geography"
```
+## Pre-release
+
+Approaching the release date, create a draft pull request into Apache Sedona
+that contains a draft of the release post for the
+[Apache Sedona Blog](https://sedona.apache.org/latest/blog). Ensure that each
+release highlight has an example and that the example runs. Blog posts are
+rendered from the
[docs/blog/posts](https://github.com/apache/sedona/tree/master/docs/blog/posts)
+subdirectory of the apache/sedona repository.
+
+Before the release branch is created, the GitHub milestone should also be
updated.
+Items that should be included in the milestone are:
+
+- Issues that were closed as completed (e.g., a PR closed them or some other
task
+ resolved them in a different way).
+- Pull Requests that did not close an issue (i.e., a PR can both represent a
discussion
+ of a problem and the code change that solves it).
+
+The milestone issue/pull request count is used in the blog post and the email
send to the
+mailing list to start the vote.
+
## Creating a release
Create a release branch on the corresponding remote pointing to the official
Apache
@@ -73,7 +93,7 @@ a committer.
```shell
git pull upstream main
-git branch -b branch-0.2.0
+git checkout -b branch-0.2.0
git push upstream -u branch-0.2.0:branch-0.2.0
```
@@ -132,6 +152,38 @@ APACHE_USERNAME=your_apache_username
dev/release/upload-candidate.sh 0.2.0 0
An email must now be sent to `[email protected]` calling on developers to
follow
the release verification instructions and vote appropriately on the source
release.
+The following may be used as a template:
+
+```
+[VOTE] Release Apache SedonaDB 0.2.0-rc0
+
+Hello,
+
+I would like to propose the following release candidate (rc0) of Apache
SedonaDB [0] version 0.2.0. This is a release consisting of 138 resolved GitHub
issues from 17 contributors [1].
+
+This release candidate is based on commit:
69f89a9a0cced55a3792eb6dfe1f76e9dd01033c [2]
+
+The source release rc0 is hosted at [3].
+
+Please download, verify checksums and signatures, run the unit tests, and vote
on the release. See [4] for how to validate a release candidate. See [5] for a
draft release post with release highlights.
+
+The vote will be open for at least 72 hours.
+
+[ ] +1 Release this as Apache SedonaDB 0.2.0
+[ ] +0
+[ ] -1 Do not release this as Apache SedonaDB 0.2.0 because...
+
+[0] https://github.com/apache/sedona-db
+[1] https://github.com/apache/sedona-db/milestone/1?closed=1
+[2] https://github.com/apache/sedona-db/tree/apache-sedona-db-0.2.0-rc1
+[3] https://dist.apache.org/repos/dist/dev/sedona/apache-sedona-db-0.2.0-rc1
+[4] https://github.com/apache/arrow-nanoarrow/blob/main/dev/release/README.md
+[5] https://github.com/apache/sedona/pull/2540
+```
+
+Ensure the links point to the correct assets/blog post pull request, the issue
count has been updated
+from the latest GitHub milestone, and the contributor count has been updated
from the
+`git shortlog` command on the release blog post.
## Publish
@@ -142,19 +194,20 @@ Apache release repository. A helper script is provided:
```shell
# upload-release.sh <version> <rc_number>
-APACHE_USERNAME=your_apache_username dev/release/upload-release.sh 0.2.0 0
+dev/release/upload-release.sh 0.2.0 0
```
-An official GitHub tag must also be created:
+An official Git tag must also be created and uploaded to the Apache remote:
```shell
-git tag -a apache-sedona-db-0.2.0 -m "SedonaDB 0.2.0"
apache-sedona-db-0.2.0-rc0
+git tag -a apache-sedona-db-0.2.0 -m "SedonaDB 0.2.0"
apache-sedona-db-0.2.0-rc0^{}
git push upstream apache-sedona-db-0.2.0
```
The prerelease located at
<https://github.com/apache/sedona-db/releases/tag/apache-sedona-db-0.2.0-rc0>
can now be edited to point to the official release tag and the GitHub release
published
-from the UI.
+from the UI. The release notes may be automatically generated by selecting
+`apache-sedona-db-0.2.0.dev` as the previous release.
### Publish Python package
@@ -184,6 +237,61 @@ twine upload wheels/**/*.whl
rm -rf wheels
```
+### Upload to `crates.io`
+
+A script is provided to upload the crates to <https://crates.io>.
+
+```shell
+cargo login
+dev/release/upload-crates-io.sh
+```
+
+### Publish release blog post
+
+Mark the [pull request into the Apache Sedona
Blog](https://github.com/apache/sedona/pulls)
+as ready for review, solicit final reviews, and merge to publish the post to
the
+[Apache Sedona Blog](https://sedona.apache.org/latest/blog).
+
+### Send email to `[email protected]` mailing list
+
+The following template may be used:
+
+```
+[ANNOUNCE] Apache SedonaDB 0.2.0 released
+
+Dear all,
+
+We are happy to report that we have released Apache SedonaDB 0.2.0.
+Thank you again for your help.
+
+SedonaDB is the first open-source, single-node analytical database engine that
treats spatial data as a first-class citizen. It is developed as a subproject
of Apache Sedona.
+
+Website:
+http://sedona.apache.org/sedonadb
+
+Release notes:
+https://sedona.apache.org/latest/blog/2025/12/01/sedonadb-020-release/
+
+Download link:
+https://www.apache.org/dyn/closer.cgi/sedona/apache-sedona-db-0.2.0
+
+Additional resources:
+Mailing list: [email protected]
+Discord: https://discord.gg/9A3k5dEBsY
+
+Regards,
+Apache Sedona Team
+```
+
+Ensure that:
+
+- The link to the release notes is correct/update to the current release
+- The email is sent from your Apache email account (i.e., `[email protected]`)
+ via the official Apache outgoing mail server.
+- The email is plain text and contains no HTML formatting (or it will be
rejected
+ from the announce list).
+- The email contains a download link (or it will be rejected from the announce
list)
+
## Bump versions
After a successful release, versions on the `main` branch need to be updated.
These
