ristretto icon indicating copy to clipboard operation
ristretto copied to clipboard

Update ristretto on pypi

Open rileyjmurray opened this issue 5 years ago • 0 comments

The last PyPI release of Ristretto was version 0.1.2 in August of 2017. Since then there have been several changes to Ristretto that might warrant a new release. To help with moving a potential release along, I provide an ultra-short summary of release steps below. (The first five-or-so times I deployed to PyPI I went through a cycle of forgetting and rediscovering these steps.)

The bare basics of the new release would consist of three steps. First, update https://github.com/erichson/ristretto/blob/2455e4ae0222a25ae08686122c67587fbe44e103/ristretto/init.py#L17 to version 0.1.3 or 0.2.0. Then compile with python setup.py sdist bdist_wheel. Finally, you can upload the resulting files to PyPI by installing twine (pip install twine) and running twine upload dist/*. You'll be asked for your PyPI credentials when you execute that command. For more details, you can refer to the PyPI docs.

Beyond the three steps there, you can draft a GitHub release to record release notes. See https://github.com/cvxgrp/cvxpy/releases/tag/v1.1.10 for an example GitHub release. When making an API-breaking release you would want to update the web documentation. However, since the web docs already suggest installing from GitHub, my guess is the web docs are already compatible with a would-be version 0.1.3 or 0.2.

If you're trying to decide between releasing under 0.1.3 or 0.2, then I'd recommend looking at the semantic versioning guidelines https://semver.org/. My guess is that releasing under 0.2 would be appropriate.

rileyjmurray avatar Mar 02 '21 17:03 rileyjmurray