Merge pull request #936 from Carreau/release-instructions

update release instruction a bit again
This commit is contained in:
Min RK 2016-01-09 12:16:50 +01:00
commit 82fb153329

View File

@ -46,15 +46,13 @@ This would ask you for confirmation before removing all untracked files. Make
sure the ``dist/`` folder is clean and avoid stale build from
previous attempts.
1. Run the following commands to generate the universal ``wheel`` and the ``sdist``:
1. Update version number in ``notebook/_version.py``.
2. Update version number in ``notebook/_version.py``.
3. Run ``$ python setup.py jsversion``. It will modify (at least)
2. Run ``$ python setup.py jsversion``. It will modify (at least)
``notebook/static/base/js/namespace.js`` to make the notebook version available
from within JavaScript.
4 . Commit and tag the release with the current version number:
3 . Commit and tag the release with the current version number:
.. code::
@ -62,7 +60,7 @@ from within JavaScript.
git tag $VERSION
5. You are now ready to build the ``sdist`` and ``wheel``:
4. You are now ready to build the ``sdist`` and ``wheel``:
.. code::
@ -70,10 +68,14 @@ from within JavaScript.
$ python setup.py bdist_wheel
6. You can now test the ``wheel`` and the ``sdist`` locally before uploading to PyPI.
5. You can now test the ``wheel`` and the ``sdist`` locally before uploading to PyPI.
Make sure to use `twine <https://github.com/pypa/twine>`_ to upload the archives over SSL.
.. code::
$ twine upload dist/*
6. If all went well, change the ``notebook/_version.py`` back adding the ``.dev`` suffix.
7. Push directly on master, not forgetting to push ``--tags``.