Build and Release

Build and Release#

This document describes how to build and release new wheels for DeepHyper.

First check the status of Python versions as it is important to know which are currently supported and which are not. See https://devguide.python.org/versions/ for more information.

Then,

  1. Go to the develop branch:

$ git checkout develop

  1. Sync develop with master:

$ git merge master

  1. Start the git flow release branch:

$ git flow release start <version>

  1. Check the deephyper/__version__.py, edit __version__ and __version_suffix__ and commit.

  2. End the release process:

$ EDITOR=vim git flow release finish <version>

  1. Push develop and master branch then check if triggered github actions finished properly.

$ git push origin master develop

  1. Push new tags:

$ git push origin --tags

  1. Remove old builds that may be in the project root directory with rm -rf dist/.

  2. Install the latest version of build and twine with uv pip install --upgrade build twine.

  3. Try to build the package wheel with python -m build.

  4. Upload the built package to PyPI using twine upload dist/*.