Show More
@@ -1,32 +1,46 b'' | |||||
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 | #. First, run :file:`build_release`, which does all the file checking and |
|
13 | #. For writing release notes, this will cleanly show who contributed as author | |
14 | building that the real release script will do. This will let you do test |
|
14 | of commits (get the previous release name from the tag list with ``git | |
|
15 | tag``):: | |||
|
16 | ||||
|
17 | git log --pretty=format:"* %an" PREV_RELEASE... | sort | uniq | |||
|
18 | ||||
|
19 | #. 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 | |||
15 | installations, check that the build procedure runs OK, etc. You may want to |
|
21 | installations, check that the build procedure runs OK, etc. You may want to | |
16 | disable a few things like multi-version RPM building while testing, because |
|
22 | disable a few things like multi-version RPM building while testing, because | |
17 | otherwise the build takes really long. |
|
23 | otherwise the build takes really long. | |
18 |
|
24 | |||
19 | #. Run the release script, which makes the tar.gz, eggs and Win32 .exe |
|
25 | #. Run the release script, which makes the tar.gz, eggs and Win32 .exe | |
20 | installer. It posts them to the site and registers the release with PyPI. |
|
26 | installer. It posts them to the site and registers the release with PyPI. | |
21 |
|
27 | |||
22 | #. Update the website with announcements and links to the updated changes.txt |
|
28 | #. Update the website with announcements and links to the updated changes.txt | |
23 | in html form. Remember to put a short note both on the news page of the |
|
29 | in html form. Remember to put a short note both on the news page of the | |
24 | site and on Launcphad. |
|
30 | site and on Launcphad. | |
25 |
|
31 | |||
26 | #. Drafting a short release announcement with i) highlights and ii) a link to |
|
32 | #. Drafting a short release announcement with i) highlights and ii) a link to | |
27 | the html version of the :ref:`Whats new <whatsnew_index>` section of the |
|
33 | the html version of the :ref:`Whats new <whatsnew_index>` section of the | |
28 | documentation. |
|
34 | documentation. | |
29 |
|
35 | |||
30 | #. Make sure that the released version of the docs is live on the site. |
|
36 | #. Make sure that the released version of the docs is live on the site. For | |
|
37 | this we are now using the gh-pages system: | |||
|
38 | ||||
|
39 | - Make a static directory for the final copy of the release docs. | |||
|
40 | - Update the :file:`index.rst` file and run :file:`build_index.py` to update | |||
|
41 | the html version. | |||
|
42 | - Update the ``stable`` symlink to point to the released version. | |||
|
43 | - Run ``git add`` for all the new files and commit. | |||
|
44 | - Run ``git push`` to update the public version of the docs on gh-pages. | |||
31 |
|
45 | |||
32 | #. Celebrate! No newline at end of file |
|
46 | #. Celebrate! |
General Comments 0
You need to be logged in to leave comments.
Login now