Merge pull request #12512 from pytest-dev/patchback/backports/8.2.x/dab29d39d7fe7505f43708532bedf37d7f616143/pr-12507

2024-06-21 17:26:45 +02:00 · 2024-06-21 17:26:45 +02:00 · 29987a4e12
parent 7a0cb6b37d b19cbf3e36
commit 29987a4e12
1 changed files with 13 additions and 0 deletions
--- a/changelog/12493.contrib.rst
+++ b/changelog/12493.contrib.rst
@ -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`