##// END OF EJS Templates
Update release instructions for stats inclusion in whatsnew section.
Fernando Perez -
Show More
@@ -19,7 +19,9 b' release milestone, current release version, and git tag.'
19 19 These variables may be used later to copy/paste as answers to the script
20 20 questions instead of typing the appropriate command when the time comes. These
21 21 variables are not used by the scripts directly; therefore, there is no need to
22 ``export`` the variables. Use the following in bash::
22 ``export`` them. The format for bash is as follows, but note that these values
23 are just an example valid only for the 5.0 release; you'll need to update them
24 for the release you are actually making::
23 25
24 26 PREV_RELEASE=4.2.1
25 27 MILESTONE=5.0
@@ -61,10 +63,14 b' If a major release:'
61 63
62 64 which may need some manual cleanup of ``stats.rst``. Add the cleaned
63 65 ``stats.rst`` results to ``docs/source/whatsnew/github-stats-X.rst``
64 where ``X`` is the numerical release version. If creating a major release,
65 make a new ``github-stats-X.rst`` file; if creating a minor release, the
66 content from ``stats.rst`` may simply be added to the top of an existing
67 ``github-stats-X.rst`` file.
66 where ``X`` is the numerical release version (don't forget to add it to
67 the git repo as well). If creating a major release, make a new
68 ``github-stats-X.rst`` file; if creating a minor release, the content
69 from ``stats.rst`` may simply be added to the top of an existing
70 ``github-stats-X.rst`` file. Finally, edit
71 ``docs/source/whatsnew/index.rst`` to list the new ``github-stats-X``
72 file you just created and remove temporarily the first entry called
73 ``development`` (you'll need to add it back after release).
68 74
69 75 To find duplicates and update `.mailmap`, use::
70 76
@@ -106,9 +112,6 b' You will likely just have to modify/comment/uncomment one of the lines setting'
106 112 ``_version_extra``
107 113
108 114
109 Comment remove the ``development`` entry in ``whatsnew/index.rst``. TODO, figure
110 out how to make that automatic.
111
112 115 5. Run the `tools/build_release` script
113 116 ---------------------------------------
114 117
@@ -20,8 +20,8 b' development work they do here in a user friendly format.'
20 20 .. toctree::
21 21 :maxdepth: 1
22 22
23 development
24 23 version5
24 github-stats-5
25 25 version4
26 26 github-stats-4
27 27 version3
General Comments 0
You need to be logged in to leave comments. Login now