diff options
author | Charles Harris <charlesr.harris@gmail.com> | 2019-12-02 17:42:20 -0700 |
---|---|---|
committer | Charles Harris <charlesr.harris@gmail.com> | 2019-12-02 17:55:22 -0700 |
commit | 0539aa4a0d24485cf3fa315a42085e16d8589523 (patch) | |
tree | 2a75919cf2eb9969b8ead0e0b3ca2f8ce1a0b907 | |
parent | 0cc8fd684e7880d30b58a78c7038c8a09e5d0a6e (diff) | |
download | numpy-0539aa4a0d24485cf3fa315a42085e16d8589523.tar.gz |
DOC: Update note for using towncrier
-rw-r--r-- | doc/HOWTO_RELEASE.rst.txt | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/HOWTO_RELEASE.rst.txt b/doc/HOWTO_RELEASE.rst.txt index 4b485c8b9..53359f0a2 100644 --- a/doc/HOWTO_RELEASE.rst.txt +++ b/doc/HOWTO_RELEASE.rst.txt @@ -246,13 +246,13 @@ updated for a major release. Check the release notes ----------------------- -Use `towncrier`_ to build the release note, copy it to the proper name, and -commit the changes. This will remove all the fragments from ``changelog/*.rst`` -and add ``doc/release/latest-note.rst`` which must be renamed with the proper -version number:: +Use `towncrier`_ to build the release note and +commit the changes. This will remove all the fragments from +``doc/release/upcoming_changes`` and add ``doc/release/<version>-note.rst``. +Note that currently towncrier must be installed from its master branch as the +last release (19.2.0) is outdated. - python -mtowncrier --version "Numpy 1.11.0" - git mv doc/release/latest-note.rst doc/release/1.11.0-notes.rst + towncrier --version "<version>" git commit -m"Create release note" Check that the release notes are up-to-date. @@ -302,7 +302,7 @@ changes:: And make sure the ``VERSION`` variable is set properly. Now you can make the release commit and tag. We recommend you don't push -the commit or tag immediately, just in case you need to do more cleanup. We +the commit or tag immediately, just in case you need to do more cleanup. We prefer to defer the push of the tag until we're confident this is the exact form of the released code (see: :ref:`push-tag-and-commit`): |