Show More
@@ -1,45 +1,53 | |||||
1 | .. _releasing_ipython: |
|
1 | .. _releasing_ipython: | |
2 |
|
2 | |||
3 | ================= |
|
3 | ================= | |
4 | Releasing IPython |
|
4 | Releasing IPython | |
5 | ================= |
|
5 | ================= | |
6 |
|
6 | |||
7 | This section contains notes about the process that is used to release IPython. |
|
7 | This section contains notes about the process that is used to release IPython. | |
8 | Our release process is currently not very formal and could be improved. |
|
8 | Our release process is currently not very formal and could be improved. | |
9 |
|
9 | |||
10 | Most of the release process is automated by the :file:`release` script in the |
|
10 | Most of the release process is automated by the :file:`release` script in the | |
11 | :file:`tools` directory. This is just a handy reminder for the release manager. |
|
11 | :file:`tools` directory. This is just a handy reminder for the release manager. | |
12 |
|
12 | |||
13 | #. For writing release notes, this will cleanly show who contributed as author |
|
13 | #. For writing release notes, this will cleanly show who contributed as author | |
14 | of commits (get the previous release name from the tag list with ``git |
|
14 | of commits (get the previous release name from the tag list with ``git | |
15 | tag``):: |
|
15 | tag``):: | |
16 |
|
16 | |||
17 |
git log -- |
|
17 | git log --format="* %aN" $PREV_RELEASE... | sort -u | |
|
18 | ||||
|
19 | .. note:: | |||
|
20 | ||||
|
21 | use:: | |||
|
22 | ||||
|
23 | git log --format="%aN <%aE>" $PREV_RELEASE... | sort -u -f | |||
|
24 | ||||
|
25 | To find duplicates and update :file:`.mailmap` | |||
18 |
|
26 | |||
19 | #. Run :file:`build_release`, which does all the file checking and building |
|
27 | #. Run :file:`build_release`, which does all the file checking and building | |
20 | that the real release script will do. This will let you do test |
|
28 | that the real release script will do. This will let you do test | |
21 | installations, check that the build procedure runs OK, etc. You may want to |
|
29 | installations, check that the build procedure runs OK, etc. You may want to | |
22 | disable a few things like multi-version RPM building while testing, because |
|
30 | disable a few things like multi-version RPM building while testing, because | |
23 | otherwise the build takes really long. |
|
31 | otherwise the build takes really long. | |
24 |
|
32 | |||
25 | #. Run the release script, which makes the tar.gz, eggs and Win32 .exe |
|
33 | #. Run the release script, which makes the tar.gz, eggs and Win32 .exe | |
26 | installer. It posts them to the site and registers the release with PyPI. |
|
34 | installer. It posts them to the site and registers the release with PyPI. | |
27 |
|
35 | |||
28 | #. Update the website with announcements and links to the updated changes.txt |
|
36 | #. Update the website with announcements and links to the updated changes.txt | |
29 | in html form. Remember to put a short note on the news page of the site. |
|
37 | in html form. Remember to put a short note on the news page of the site. | |
30 |
|
38 | |||
31 | #. Drafting a short release announcement with i) highlights and ii) a link to |
|
39 | #. Drafting a short release announcement with i) highlights and ii) a link to | |
32 | the html version of the :ref:`Whats new <whatsnew_index>` section of the |
|
40 | the html version of the :ref:`Whats new <whatsnew_index>` section of the | |
33 | documentation. |
|
41 | documentation. | |
34 |
|
42 | |||
35 | #. Make sure that the released version of the docs is live on the site. For |
|
43 | #. Make sure that the released version of the docs is live on the site. For | |
36 | this we are now using the gh-pages system: |
|
44 | this we are now using the gh-pages system: | |
37 |
|
45 | |||
38 | - Make a static directory for the final copy of the release docs. |
|
46 | - Make a static directory for the final copy of the release docs. | |
39 | - Update the :file:`index.rst` file and run :file:`build_index.py` to update |
|
47 | - Update the :file:`index.rst` file and run :file:`build_index.py` to update | |
40 | the html version. |
|
48 | the html version. | |
41 | - Update the ``stable`` symlink to point to the released version. |
|
49 | - Update the ``stable`` symlink to point to the released version. | |
42 | - Run ``git add`` for all the new files and commit. |
|
50 | - Run ``git add`` for all the new files and commit. | |
43 | - Run ``git push`` to update the public version of the docs on gh-pages. |
|
51 | - Run ``git push`` to update the public version of the docs on gh-pages. | |
44 |
|
52 | |||
45 | #. Celebrate! |
|
53 | #. Celebrate! |
General Comments 0
You need to be logged in to leave comments.
Login now