From 39a46bed3a82e8a480913a3182712771e21f1830 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20Kone=C4=8Dn=C3=BD?= Date: Fri, 2 Sep 2022 10:55:07 +0200 Subject: [PATCH] Update release guide MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit I found out that the towncrier doesn't work as it should (the version isn't correct) if the Anitya in the newest version isn't installed in the same virtualenv as towncrier. The guide was updated with note about this. Signed-off-by: Michal Konečný --- docs/contributing.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/contributing.rst b/docs/contributing.rst index 0aae43759..d271a0d59 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -341,6 +341,13 @@ If you are a maintainer and wish to make a release, follow these steps: Just ignore this and remove all of them manually; release notes will be generated anyway. +.. note:: + You need to have Anitya installed as well for ``towncrier`` to see the newest + version. I recommend doing this in separate virtualenv and installing the Anitya + with ``pip install -e .``, which will automatically reflect any change made to + code in the installation. The ``towncrier`` needs to be installed in the same + python virtualenv to see those changes. + 5. Remove every remaining news fragment from ``news`` folder. 6. Generate new DB schema image by running ``./generate_db_schema`` in ``docs`` folder.