Add release instructions

This commit is contained in:
Matthias Bussonnier 2015-12-11 18:32:19 +01:00
parent 85b1f638a0
commit df32201009

View File

@ -27,3 +27,43 @@ the bundled and minified Javacript by using the option
number of requests that the browser make to the server, but can allow to test
Javascript file modification without going through the compilation step that
can take up to 30 sec.
Making a notebook release
-------------------------
Make sure you have followed the step above and have all the tools to genereate
the minified javascript and css files.
Make sure the repository is clean of any file that could be problematic.
You can remove all non-tracked files with:
.. code::
$ git clean -xfdi
This would ask you for confirmation before removing all untracked file. Make
sure the ``dist/`` folder in particular is clean and avoid stale build from
previous attempts.
Run the following two commands to generate the universal ``wheel`` and the ``sdist``:
.. code::
$ python setup.py sdist
$ python setup.py bdist_wheel --universal
.. note::
The above command will modify (at least) the following file :
``notebook/static/base/js/namespace.js`` to make the notebook version
availlable from javascript.
You can now test the ``wheel`` and the ``sdist`` locally before uploading to PyPI.
Make sure to use twine to upload the archives over SSL.
.. code::
$ twine upload dist/*