Release Process

Uploading a Tarski release to the Python Package Index

Docs: https://packaging.python.org/tutorials/packaging-projects/

  1. Update the CHANGELOG.md file.

  2. Update the version number in src/tarski/version.py

  3. Commit. Use message like “Preparing for release 0.6.0”.

  4. Go to the master branch and merge the devel branch.

  5. Tag the release.

        export TARSKI_RELEASE="v0.2.0"
        git tag -a ${TARSKI_RELEASE} -m "Tarski release ${TARSKI_RELEASE}"
    
  6. Run the following instructions from the root directory of the project:

        python3 -m pip install --upgrade twine setuptools wheel  # (optional)
    
        rm -rf dist/
        python3 setup.py sdist bdist_wheel
    
        # Test first (result will go to https://test.pypi.org/project/tarski/):
        python3 -m twine upload --skip-existing --repository-url https://test.pypi.org/legacy/ dist/*
    
        # Then go!
        python3 -m twine upload --skip-existing dist/*
    
  7. Push all code changes plus the tag to the repo:

        git push && git push origin ${TARSKI_RELEASE}
    
  8. Check the Github releases page to make sure the new release appears there and can be downwloaded.