@@ -57,8 +57,8 @@ For conducting TLS connectivity tests, there are a few X.509 certificates at
5757within the README file in this folder.
5858
5959
60- Preparing a release
61- ===================
60+ Preparing a GA release
61+ ======================
6262
6363To create a new release, you must:
6464
@@ -98,6 +98,23 @@ patch versions for the last two minor releases.
9898To make changes to the RTD configuration (e.g., to activate or deactivate a
9999release version), please contact the `@crate/docs `_ team.
100100
101+ Preparing a pre-release
102+ =======================
103+
104+ To give users a chance to validate new releases with significant changes on
105+ their downstream projects like `validate crate 2.1.0.dev3 `_, it is recommended
106+ to publish pre-release packages, which is a manual procedure.
107+
108+ First, in ``pyproject.toml ``, temporarily swap out the dynamic versioning
109+ ``dynamic = ["version"] `` and use a fixed version number, for example
110+ ``version = "2.1.0.dev3" ``.
111+
112+ Build, validate, and upload the package to PyPI manually::
113+
114+ hatch build
115+ twine check dist/crate-2.1.0.dev3*
116+ hatch publish dist/crate-2.1.0.dev3*
117+
101118Writing documentation
102119=====================
103120
@@ -126,5 +143,6 @@ nothing special you need to do to get the live docs to update.
126143.. _useful command-line options for zope-testrunner : https://pypi.org/project/zope.testrunner/#some-useful-command-line-options-to-get-you-started
127144.. _uv : https://docs.astral.sh/uv/
128145.. _UV_PYTHON : https://docs.astral.sh/uv/configuration/environment/#uv_python
146+ .. _validate crate 2.1.0.dev3 : https://github.com/crate/crate-python/issues/787
129147.. _versions hosted on ReadTheDocs : https://readthedocs.org/projects/crate-python/versions/
130148.. _pytest : https://docs.pytest.org/en/stable/
0 commit comments