From 5d95f09b2acc8a1605aee64784c466ff409828df Mon Sep 17 00:00:00 2001 From: Sviatoslav Sydorenko Date: Fri, 21 Jun 2024 15:03:36 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20a=20change=20note=20for=20?= =?UTF-8?q?PR=20#12493?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- changelog/12493.contrib.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 changelog/12493.contrib.rst diff --git a/changelog/12493.contrib.rst b/changelog/12493.contrib.rst new file mode 100644 index 000000000..db3d04569 --- /dev/null +++ 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`