Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 1.33 KB

HOW_TO_RELEASE.md

File metadata and controls

54 lines (40 loc) · 1.33 KB
Raw

How to release

The document describes how to release hpo-toolkit to PyPi and conda-forge.

Release checklist
  • update documentation notebooks to present the latest features
  • create a release branch
  • remove deprecated methods targeted for removal in this version. The TODO markers are labeled using the target version (e.g. TODO[v0.3.0])
  • bump versions to a release:
    • src/hpotk/__init__.py
    • recipe/meta.yaml
  • ensure the CI passes, check that coverage levels are acceptable
  • deploy to PyPi (described below)
  • merge to main
  • create the release tag and GitHub version
  • merge main to development
  • bump versions to a dev version
Uploading to conda-forge
# https://conda-forge.org/#contribute

PyPi

The following packages are required for testing, building, and deployment to PyPi:

  • tox
  • build
  • twine

Consider creating a dedicated virtual environment with the above packages. Then, run the following to deploy hpo-toolkit to PyPi:

cd hpo-toolkit

# Test
tox run

# Build
python3 -m build

# Deploy
python3 -m twine upload dist/*

# Clear the deployed files
rm -rf dist

The commands will run tests, build source distribution and a wheel, and deploy the source distribution and wheel to PyPi. During deployment, you will be prompted for your PyPi credentials.