Skip to content

Commit 046c13e

Browse files
committed
📝 Document the need to merge the release PR
1 parent 1342a99 commit 046c13e

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

docs/contributing/release_guide.rst

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,31 @@ The release stage
7474
- a Git tag
7575
- a GitHub Releases page
7676
- a GitHub Discussions page
77+
- a GitHub pull request
7778

78-
9. Tell everyone you released a new version of |project| :)
79+
9. Merge the release pull request containing the changelog
80+
update patch. Use the natural/native merge strategy.
81+
82+
.. danger::
83+
84+
**Do not** use squash or rebase. The ``release/vNUMBER``
85+
branch contains a tagged commit. That commit must become
86+
a part of the repository's default branch. Failing to
87+
follow this instruction will result in ``setuptools-scm``
88+
getting confused and generating the intermediate commit
89+
versions incorrectly.
90+
91+
.. tip::
92+
93+
If you used a YOLO mode when triggering the release
94+
automation, the branch protection rules may prevent you
95+
from being able to click the merge button. In such a case
96+
it is okay to *temporarily* deselect the :guilabel:`Do not
97+
allow bypassing the above settings` setting in the branch
98+
protection configuration, click the merge button, with an
99+
administrator override and re-check it immediately.
100+
101+
10. Tell everyone you released a new version of |project| :)
79102

80103

81104
.. _GitHub Actions CI/CD workflow:

0 commit comments

Comments
 (0)