Skip to content

Commit dab29d3

Browse files
Merge pull request #12507 from webknjaz/maintenance/hotfixes/note/sphinx-towncrier-draft
📝 Add a change note for PR #12493
2 parents b864e50 + 5d95f09 commit dab29d3

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

changelog/12493.contrib.rst

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

0 commit comments

Comments
 (0)