Skip to content

How to make a release

agramfort edited this page Oct 13, 2012 · 1 revision
  • Write the changelog (doc/whats_new.rst). Commit counts can be generated using git log <last_release>.. | git shortlog -s -n

  • Fix Milestone issues

  • Compile documentation, make sure all examples compile. If sphinx refuses to work generate reference for functions, use sphinx 1.0.0 (which seems to work fine).

  • Tag master with X.X-branching

  • Create a new branch X.X. Next step for both branches separately (once with -git, once without)

  • Change the version number in

    • doc/conf.py

    • mne/__init__.py

  • check on python 2.6, 2.7

  • Tag X.X branch as X.X.

  • then python setup.py sdist will create a .tar.gz in the dist/ directory.

  • untar and test it

  • upload to PyPi with python setup.py sdist upload

  • hide the old version on the PyPi website

  • remove all deprecated features from dev that are to be removed in the next version.

Clone this wiki locally