Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
douglasdavis committed Dec 19, 2024
1 parent f58f26e commit 8ff99b0
Showing 1 changed file with 3 additions and 32 deletions.
35 changes: 3 additions & 32 deletions docs/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,35 +38,6 @@ Push the tag to GitHub (assuming ``origin`` points to the
Making the release
------------------

To make a release of ``dask-histogram`` we just need the ``build`` and
``twine`` packages:

.. code-block::
$ pip install build twine
The build-system that we use (``hatch`` with ``hatch-vcs``) will
automatically set a version based on the latest tag in the repository;
after making the tag we just need to generate the source distribution
and wheel, this is handled by the ``build`` package:

.. code-block::
$ python -m build
Now a new ``dist/`` directory will appear, which contains the files
(continuing to use our example version ``2023.3.1``):

.. code-block::
dask_histogram-2023.3.1.tar.gz
dask_histogram-2023.3.1-py3-none-any.whl
Now we just upload these files to PyPI with ``twine``:

.. code-block::
$ twine upload dist/dask_histogram-2023.3.1*
The GitHub ``regro-cf-autotick-bot`` account will automatically create
a pull request to release a new version on ``conda-forge``.
After pushing the tag, GitHub actions will take care of uploading the
wheel and sdist to PyPI. Please go to the Releases page on the GitHub
repository and Draft a new release associated with the tag.

0 comments on commit 8ff99b0

Please sign in to comment.