From b19cbf3e3613a8cdd5b9094f48f62577cc8e1f50 Mon Sep 17 00:00:00 2001 From: Ronny Pfannschmidt Date: Fri, 21 Jun 2024 15:26:11 +0200 Subject: [PATCH] Merge pull request #12507 from webknjaz/maintenance/hotfixes/note/sphinx-towncrier-draft MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 📝 Add a change note for PR #12493 (cherry picked from commit dab29d39d7fe7505f43708532bedf37d7f616143) --- 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`