Skip to content

Commit

Permalink
Update release guide
Browse files Browse the repository at this point in the history
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ý <[email protected]>
  • Loading branch information
Zlopez committed Sep 2, 2022
1 parent 8832324 commit 39a46be
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 39a46be

Please sign in to comment.