diff options
| -rw-r--r-- | doc/RELEASE_WALKTHROUGH.rst.txt | 24 |
1 files changed, 16 insertions, 8 deletions
diff --git a/doc/RELEASE_WALKTHROUGH.rst.txt b/doc/RELEASE_WALKTHROUGH.rst.txt index 9a2b71d7e..91c5954bc 100644 --- a/doc/RELEASE_WALKTHROUGH.rst.txt +++ b/doc/RELEASE_WALKTHROUGH.rst.txt @@ -5,6 +5,20 @@ replace 1.14.3 by the correct version. Release Walkthrough ==================== +Update Release documentation +---------------------------- + +The file ``doc/changelog/1.14.3-changelog.rst`` should be updated to reflect +the final list of changes and contributors. This text can be generated by:: + + $ python tools/changelog.py $GITHUB v1.14.2..maintenance/1.14.x > doc/changelog/1.14.3-changelog.rst + +where ``GITHUB`` contains your github access token. This text should also be +appended to ``doc/release/1.14.3-notes.rst`` for release updates, though not +for new releases like ``1.14.0`` to keep those notes short. The file +``doc/source/release.rst`` should also be updated with a link to the new +release notes. + Prepare the release commit -------------------------- @@ -212,11 +226,5 @@ Announce to mailing lists The release should be announced on the numpy-discussion, scipy-devel, scipy-user, and python-announce-list mailing lists. Look at previous -announcements for the basic template. The contributor list can be generated as -follows:: - - $ cd ../numpy - $ ./tools/changelog.py $GITHUB v1.14.2..v1.14.3 > tmp.rst - -The contents of ``tmp.rst`` can then be cut and pasted into the announcement -email. +announcements for the basic template. The contributor and PR lists +are the same as generated for the release notes above. |