Show More
@@ -0,0 +1,56 b'' | |||
|
1 | .. making_release:: | |
|
2 | ||
|
3 | Making an IPython release | |
|
4 | ========================= | |
|
5 | ||
|
6 | 1. Make sure the repository is clean of any file that could be problematic. | |
|
7 | Remove all non-tracked files with: | |
|
8 | ||
|
9 | .. code:: | |
|
10 | ||
|
11 | git clean -xfdi | |
|
12 | ||
|
13 | This will ask for confirmation before removing all untracked files. Make | |
|
14 | sure the ``dist/`` folder is clean to avoid any stale builds from | |
|
15 | previous build attempts. | |
|
16 | ||
|
17 | 2. Update version number and ``_version_extra`` content in | |
|
18 | ``IPython/core/release.py``. | |
|
19 | ||
|
20 | Make sure the version number matches pep440, in particular, `rc` and `beta` | |
|
21 | are not separated by `.` or the `sdist` and `bdist` will appear as different | |
|
22 | releases. For example, a valid version number for a release candidate (rc) | |
|
23 | release is: ``1.3rc1``. Notice that there is no separator between the '3' | |
|
24 | and the 'r'. | |
|
25 | ||
|
26 | ||
|
27 | 3. Commit and tag the release with the current version number: | |
|
28 | ||
|
29 | .. code:: | |
|
30 | ||
|
31 | git commit -am "release $VERSION" | |
|
32 | git tag $VERSION | |
|
33 | ||
|
34 | ||
|
35 | 4. Build the ``sdist`` and ``wheel``: | |
|
36 | ||
|
37 | .. code:: | |
|
38 | ||
|
39 | python setup.py sdist --formats=zip,gztar | |
|
40 | python2 setup.py bdist_wheel | |
|
41 | python3 setup.py bdist_wheel | |
|
42 | ||
|
43 | ||
|
44 | 5. Be sure to test the ``wheel`` and the ``sdist`` locally before uploading | |
|
45 | them to PyPI. Make sure to use `twine <https://github.com/pypa/twine>`_ to | |
|
46 | upload these archives over SSL. | |
|
47 | ||
|
48 | .. code:: | |
|
49 | ||
|
50 | $ twine upload dist/* | |
|
51 | ||
|
52 | 6. If all went well, change the ``_version_extra = ''`` in | |
|
53 | ``IPython/core/release.py`` back to the ``.dev`` suffix, or | |
|
54 | ``_version_extra='.dev'``. | |
|
55 | ||
|
56 | 7. Push directly to master, remembering to push ``--tags`` too. No newline at end of file |
@@ -16,4 +16,4 b' on the IPython GitHub wiki.' | |||
|
16 | 16 | :maxdepth: 1 |
|
17 | 17 | |
|
18 | 18 | release_process |
|
19 |
|
|
|
19 | making_release |
@@ -1,8 +1,8 b'' | |||
|
1 | 1 | .. _release_process: |
|
2 | 2 | |
|
3 | ====================== | |
|
4 | Releasing core IPython | |
|
5 | ====================== | |
|
3 | ======================= | |
|
4 | IPython release process | |
|
5 | ======================= | |
|
6 | 6 | |
|
7 | 7 | This document contains the process that is used to create an IPython release. |
|
8 | 8 |
|
1 | NO CONTENT: file was removed |
General Comments 0
You need to be logged in to leave comments.
Login now