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 becomes 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.

  2. Run unittests located at deephyper/tests/ with:

$ pytest --run fast,slow,hps,nas,ray,mpi tests

  1. Run doctests located at deephyper/docs/ with:

$ make doctest

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

  2. Start the git flow release branch:

$ git flow release start <version>

  1. End the release:

$ EDITOR=vim git flow release finish <version>

  1. Push commits and tags:

$ git push origin --tags

  1. Make sure to be on the correct branch/tag

For final release only:

Follow the instructions in the Python Packaging User Guide to build and publish the package to PyPI.

  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 pip install --upgrade build twine.

  3. Build the package with python -m build.

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