How to Release a New HTMap Version

To release a new version of HTMap:

  1. Run binder/exec.sh, check that they executed correctly by loading them up in a Jupyter session, and commit the resulting executed tutorial notebooks into the repository.

  2. Make sure that the version PR actually bumps the version in setup.cfg.

  3. Merge the version PR into master via GitHub.

  4. Make a GitHub release from https://github.com/htcondor/htmap/releases, based on master. Name it exactly vX.Y.Z, and link to the release notes for that version (like https://htmap.readthedocs.io/en/latest/versions/vX_Y_Z.html ) in the description (the page will not actually exist yet).

  5. Delete anything in the dist/ directory in your copy of the repository.

  6. On your machine, make sure master is up-to-date, then run python3 setup.py sdist bdist_wheel to create the source distribution and the wheel.

  7. Install Twine: pip install twine.

  8. Upload to PyPI: python3 -m twine upload dist/*. You will be prompted for your PyPI login.

HTMap’s default Docker image is defined by the docker/ directory in this repository. It is built automatically by Docker Hub, see the builds page. The Binder-served tutorials also use an image built by Docker Hub: see here, and are defined by the binder/ directory in this repository.