Skip to content

Documentation: Educate about publishing pre-release packages #789

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
amotl wants to merge 1 commit into from
Closed

Documentation: Educate about publishing pre-release packages #789

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions DEVELOP.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ For conducting TLS connectivity tests, there are a few X.509 certificates at
within the README file in this folder.


Preparing a release
===================
Preparing a GA release
======================

To create a new release, you must:

Expand Down Expand Up @@ -98,6 +98,23 @@ patch versions for the last two minor releases.
To make changes to the RTD configuration (e.g., to activate or deactivate a
release version), please contact the `@crate/docs`_ team.

Preparing a pre-release
=======================

To give users a chance to validate new releases with significant changes on
their downstream projects like `validate crate 2.1.0.dev3`_, it is recommended
to publish pre-release packages, which is a manual procedure.

First, in ``pyproject.toml``, temporarily swap out the dynamic versioning
``dynamic = ["version"]`` and use a fixed version number, for example
``version = "2.1.0.dev3"``.

Build, validate, and upload the package to PyPI manually::

hatch build
twine check dist/crate-2.1.0.dev3*
hatch publish dist/crate-2.1.0.dev3*

Writing documentation
=====================

Expand Down Expand Up @@ -126,5 +143,6 @@ nothing special you need to do to get the live docs to update.
.. _useful command-line options for zope-testrunner: https://pypi.org/project/zope.testrunner/#some-useful-command-line-options-to-get-you-started
.. _uv: https://docs.astral.sh/uv/
.. _UV_PYTHON: https://docs.astral.sh/uv/configuration/environment/#uv_python
.. _validate crate 2.1.0.dev3: https://github.com/crate/crate-python/issues/787
.. _versions hosted on ReadTheDocs: https://readthedocs.org/projects/crate-python/versions/
.. _pytest: https://docs.pytest.org/en/stable/
Loading