Releasing a New Version

1. Bump the version in version.py
2. Commit changes and create a new tag prefixed with v, e.g. v0.1.2.
3. Push to Github - the tag should trigger a Release job on Azure
4. On Azure, go to Pipelines > Release (name of pipeline), open build, click on ... at top right and select Release
5. Verify that all the files have been uploaded to PyPi
6. After a while, the conda-forge bot will automatically detect the new package on PyPi and open a PR, which just needs to be merged

Common issues

Forgetting to update version number

Sometimes, you may scratch your head when testing a new CI config, and the Test pipeline passes, but the Release pipeline fails. In this case, check whether the pip install --find-links=dist/ openTSNE is actually installing the newly built wheels. If, for instance, version 1.0.1 is released on PyPI, and you're testing a new release config, but haven't updated the version to 1.0.2, pip is probably fetching the version from PyPI and not your new wheels. If your new build contains code changes, then the release tests might fail.

To avoid this issue, ensure that you update the version in version.py to something that isn't available on PyPI. Then, pip install will see that the local wheels have a higher version, and will use that over the PyPI releases.

So far, I haven't found a way to convince pip to prioritize local wheels over the PyPI wheels, even if they are the same version.