Skip to content

Commit d3e7c93

Browse files
committed
Change statement about appending to dependency changes per review comment
1 parent 573dc24 commit d3e7c93

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

doc/user_guide/features/creating_a_release.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ The ``release:prepare`` nox session affects the ``pyproject.toml``, ``version.py
99
* Creates & switches to a release branch (can be skipped with ``--no-branch``)
1010
* 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``
12-
* Appends to the versioned changes file any direct dependency changes between the current ``poetry.lock`` and the one from the latest tag
12+
* Adds a description of dependency changes to the versioned changes file:
13+
14+
* Only direct dependencies are described, no transitive dependencies
15+
* Changes are detected by comparing the current content of file ``poetry.lock`` to the latest Git tag.
1316
* Updates the ``changelog.md`` list with the newly create versioned changes file
1417
* Commits the changes (can be skipped with ``--no-add``)
1518
* Pushes the changes and creates a PR (can be deactivated with ``--no-pr``)

0 commit comments

Comments
 (0)