Skip to content

Commit 9fc77aa

Browse files
committed
[ci skip] flesh out part of the release docs
1 parent 053d94f commit 9fc77aa

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/source/developing/release.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,11 @@ This script will also make zip archive, which can be used for local testing to m
9898
.. note::
9999
This zip folder is not what we release. The actual zip folder is generated by Github, so that should be tested as well once it has been made.
100100

101-
The release script does not push any changes to Github. That must be done manually with a ``git push``.
101+
.. note::
102+
Once the script has generated the new release branch, update the changelog headings from "Changes in main" to "Changes in r12345" etc,
103+
and delete the note near the top of the changelog about changes in ``main`` relative to the most recent release.
104+
105+
The release script does not push any changes to Github. Once you are ready to push the release branch, this must be done manually with a ``git push``. (This is a separate step from pushing the tag in the next step.)
102106

103107

104108
Release steps

0 commit comments

Comments
 (0)