mirror/notebook
2
0
Fork 0
mirror of https://github.com/jupyter/notebook.git synced 2025-01-30 12:11:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

Consolidate release notes into RELEASE.md

Browse Source
This commit is contained in:
Steven Silvester 2020-05-10 02:17:45 -05:00
parent b561e734fc
commit 87201a5339
3 changed files with 2 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
RELEASE.md
View File

@ -40,6 +40,7 @@ npm install -g po2json
```bash
vim notebook/_version.py
python setup.py jsversion
git commit -am "Release $(python setup.py --version)"
git tag $(python setup.py --version)
```
@ -61,7 +62,7 @@ twine check dist/* && twine upload dist/*
## Change back to dev version
```bash
vim notebook/_version.py
vim notebook/_version.py # Add the .dev suffix
git commit -am "Back to dev version"
```

67
docs/source/development_release.rst
View File

@ -1,67 +0,0 @@
.. _notebook_release:
Making a Notebook release
=========================
This document guides a contributor through creating a release of the Jupyter
notebook.
Check installed tools
---------------------
Review ``CONTRIBUTING.rst``. Make sure all the tools needed to generate the
minified JavaScript and CSS files are properly installed.
Clean the repository
--------------------
You can remove all non-tracked files with:
.. code:: bash
git clean -xfdi
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.
Create the release
------------------
#. Update version number in ``notebook/_version.py``.
#. Run this command:
.. code:: bash
python setup.py jsversion
It will modify (at least) ``notebook/static/base/js/namespace.js`` which
makes the notebook version available from within JavaScript.
#. Commit and tag the release with the current version number:
.. code:: bash
git commit -am "release $VERSION"
git tag $VERSION
#. You are now ready to build the ``sdist`` and ``wheel``:
.. code:: bash
python setup.py sdist
python setup.py bdist_wheel
#. 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:: bash
twine upload dist/*
#. If all went well, change the ``notebook/_version.py`` back adding the
``.dev`` suffix.
#. Push directly on master, not forgetting to push ``--tags`` too.

1
docs/source/index.rst
View File

@ -33,7 +33,6 @@ The Jupyter Notebook
:caption: Contributor Documentation
contributing
development_release
development_faq
.. toctree::