Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 838 Bytes

RELEASE_HOWTO.md

File metadata and controls

38 lines (25 loc) · 838 Bytes

How to Release

Here's a quick step-by-step for cutting a new release of gatspy.

Pre-release

  1. update version in gatspy.__version__

  2. update version in docs/conf.py (two places!)

  3. create a release tag; e.g.

    $ git tag -a v0.2 -m 'version 0.2 release'
    
  4. push the commits and tag to github

  5. confirm that CI tests pass on github

  6. under "tags" on github, update the release notes

  7. push the new release to PyPI:

    $ python setup.py sdist upload
    
  8. change directories to doc and build the documentation:

    $ cd doc/
    $ make html     # build documentation
    $ make publish  # publish to github pages
    

Post-release

  1. update version in gatspy/__init__.py to next version; e.g. '0.3-git'

  2. update version in doc/conf.py to the same (in two places)