Skip to content

Commit fc95d41

Browse files
committed
Correct release:prepare to be clearer which files are touched and that version.py is also altered
1 parent ad765e0 commit fc95d41

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/user_guide/features/creating_a_release.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ Creating a release
44
Preparing a release
55
+++++++++++++++++++
66

7-
The ``release:prepare`` nox session affects files in the ``doc/changes`` directory:
7+
The ``release:prepare`` nox session affects the ``pyproject.toml``, ``version.py``, and files in the ``doc/changes`` directory:
88

99
* Creates & switches to a release branch (can be skipped with ``--no-branch``)
10-
* Updates the version in the ``pyproject.toml``
10+
* Updates the version in the ``pyproject.toml`` and ``version.py``
1111
* Moves the content of unreleased changes file ``unreleased.md`` to a versioned changes file ``changes_<version>.md``
1212
* Appends to the versioned changes file any direct dependency changes between the current ``poetry.lock`` and the one from the latest tag
1313
* Updates the ``changelog.md`` list with the newly create versioned changes file

0 commit comments

Comments
 (0)