File tree Expand file tree Collapse file tree 1 file changed +24
-1
lines changed Expand file tree Collapse file tree 1 file changed +24
-1
lines changed Original file line number Diff line number Diff line change @@ -74,8 +74,31 @@ The release stage
74
74
- a Git tag
75
75
- a GitHub Releases page
76
76
- a GitHub Discussions page
77
+ - a GitHub pull request
77
78
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 | :)
79
102
80
103
81
104
.. _GitHub Actions CI/CD workflow :
You can’t perform that action at this time.
0 commit comments