Making a release

This is a guide on how to make a release of scanpy for maintainers.

Checking that PyPI will accept it

Sometimes PyPI will reject a build. You can locally check whether the build is acceptable with twine check.

# First, make a build
python setup.py sdist bdist_wheel

# Now check that build
twine check dist/*  # Assuming dist is otherwise empty

Actually making release

First, make sure you’re working repository is clean and is on the commit you’d like to release from. Then follow these steps:

# Tag the commit with version info
git tag {version}  # where version is a version number like "1.7.0"

# Build distributions and wheel
python setup.py sdist bdist_wheel
# you can check that the previous step worked by installing from it's results
# e.g. pip install dist/scanpy-{version}-py3-none-any.whl

# Once you're confident the build looks good, push the tag to github
git push upstream {version}

# Upload wheel and code distribution to pypi
twine upload dist/scanpy-{version}

After making a release

After a major or minor release has been made:

Tweet about it!
Create a new release notes file for the next minor release. This should only be added to the dev branch.

After any release has been made:

Create a new release notes file for the next bugfix release. This should be included in both dev and stable branches release-latest.rst