Skip to content

Latest commit

 

History

History
37 lines (30 loc) · 1.13 KB

PUBLISH.md

File metadata and controls

37 lines (30 loc) · 1.13 KB

How to Publish a Release

  1. Increment the version number in init.py using semver conventions:

    1. MAJOR version when you make incompatible API changes,
    2. MINOR version when you add functionality in a backwards compatible manner, and
    3. PATCH version when you make backwards compatible bug fixes.

  2. Commit the change to the master branch with the version number and any fixed issues referenced in the title.

git commit -m "v2.0.0 - return exit code from executed command, fix #3"
  1. Build and upload the source distribution to staging – TestPyPI (Test Python Package Index):
# Run test, build the package, and upload to TestPyPI. 
make upload-test
  1. Download the package and perform any manual qualification steps:
# Install from TestPyPI. 
make install-test
  1. Build and upload the source distribution to production – PyPI (Python Package Index):
# Run tests, build the package, upload to PyPI, and publish a tagged GitHub release. 
make upload
  1. Install and enjoy! 😀:
# Install from PyPI.  
make install