From feb172f4a25a5e95f5d98d24c491180d545a1540 Mon Sep 17 00:00:00 2001 From: Dmitry Kropachev Date: Thu, 27 Nov 2025 19:07:09 -0400 Subject: [PATCH] Add RELEASE.md Add a file that describes release proccess --- RELEASE.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000000..0bc866d994 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,31 @@ +Release Preparation Guide +========================= + +Follow these steps to prepare a new release (example: `3.29.6`): + +1) Version bump + - Update `cassandra/__init__.py` `__version_info__`/`__version__`. + - Add new tag with `-scylla` postfix to `docs/conf.py` `TAGS` and set `LATEST_VERSION`. + - Refresh any user-facing version strings (e.g. `docs/installation.rst`). + +2) Changelog + - Add a new section at the top of `CHANGELOG.rst` with the release date. + - List each merged PR since the previous release in the format `* (#)`. + +3) Dependency/docs metadata + - Update `docs/conf.py` multiversion tag list if new published doc tags are required. + - If documentation styling or assets changed, ensure `uv.lock` (or other doc assets) are refreshed. + +4) Tests and validation + - Run unit tests: `uv run pytest tests/unit`. + - Spot-check relevant integration tests if new protocol or cluster behavior was touched. + - Build artifacts to confirm packaging still works: `uv run python -m build`. + +5) Commit and tag + - Commit with an imperative subject, e.g. `Release 3.29.6: changelog, version and documentation`. + - Tag the commit as `3.29.6-scylla` if publishing docs, and `3.29.6` for the driver if applicable. + +6) Publish checklist + - Push tags and commit. + - Publish wheels/sdist to the package index. + - Trigger docs build for the new tag/branch.