Skip to content

Commit

Permalink
Merge pull request jupyter#936 from Carreau/release-instructions
Browse files Browse the repository at this point in the history
update release instruction a bit again
  • Loading branch information
minrk committed Jan 9, 2016
2 parents 8d47271 + 02b5f46 commit 82fb153
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions docs/source/development_js.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,34 +46,36 @@ 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::
git commit -am "release $VERSION"
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::
$ python setup.py sdist --formats=zip,gztar
$ 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``.

0 comments on commit 82fb153

Please sign in to comment.