Merge pull request #12507 from webknjaz/maintenance/hotfixes/note/sphinx-towncrier-draft

📝 Add a change note for PR #12493
This commit is contained in:
Ronny Pfannschmidt 2024-06-21 15:26:11 +02:00 committed by GitHub
commit dab29d39d7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 0 deletions

View File

@ -0,0 +1,13 @@
The change log draft preview integration has been refactored to use a
third party extension ``sphinxcontib-towncrier``. The previous in-repo
script was putting the change log preview file at
:file:`doc/en/_changelog_towncrier_draft.rst`. Said file is no longer
ignored in Git and might show up among untracked files in the
development environments of the contributors. To address that, the
contributors can run the following command that will clean it up:
.. code-block:: console
$ git clean -x -i -- doc/en/_changelog_towncrier_draft.rst
-- by :user:`webknjaz`