Skip to content

Latest commit

 

History

History
66 lines (40 loc) · 1.66 KB

RELEASING.rst

File metadata and controls

66 lines (40 loc) · 1.66 KB

Preparing a release

Notes on creating a release. These notes apply my own system, currently OS X 10.9, with mpfr and gmp installed via MacPorts.

  1. Make sure that you have a clean and up-to-date source tree.

  2. Create a release branch:

    git checkout release/0.4.0
    
  3. Update version numbers if necessary. Places that need to be updated include:

    docs/conf.py ('version' and 'release' keys)
    setup.py ('version')
    

    You might also look at:

    • CHANGELOG.rst
    • INSTALL.rst
    • RELEASING.rst (this document).
  4. Create a test release with python setup.py sdist; copy the generated tarball and check that it's possible to install from it. Run tests.

  5. When satisfied, tag the release:

    git tag -a v0.4.0
    
  6. Upload the release to PyPI. Register first if necessary:

    python setup.py sdist upload
    

    If you don't have PyPI details registered in ~/.pypirc, this may fail; in that case you'll need to reissue the 'python setup.py sdist upload' command in the form:

    python setup.py sdist register upload
    

    Make sure you answer "y" to the "Save your login (y/N)" prompt!

  7. Update tags on ReadTheDocs.

  8. Building docs to upload to PyPI. In the docs directory, do:

    make html
    cd build/html
    zip -r bigfloat_docs.zip *
    mv -i bigfloat_docs.zip ~/Desktop
    

    Now you can go to:

    http://pypi.python.org/pypi?%3Aaction=pkg_edit&name=bigfloat
    

    and upload the documentation from there. The documentation is uploaded to http://pythonhosted.org/bigfloat.

Post-release

  1. Merge the release branch back into master.
  2. Bump version number again.