@@ -27,7 +27,7 @@ To release a new version of pybind11:
2727 ``include/pybind11/detail/common.h ``. PATCH should be a simple integer.
2828 - Update the version HEX just below, as well.
2929 - Update ``pybind11/_version.py `` (match above)
30- - Run ``nox -s tests_packaging` `` to ensure this was done correctly.
30+ - Run ``nox -s tests_packaging `` to ensure this was done correctly.
3131 - Ensure that all the information in ``setup.cfg `` is up-to-date, like
3232 supported Python versions.
3333 - Add release date in ``docs/changelog.rst ``.
@@ -50,13 +50,15 @@ To release a new version of pybind11:
5050- Make a GitHub release (this shows up in the UI, sends new release
5151 notifications to users watching releases, and also uploads PyPI packages).
5252 (Note: if you do not use an existing tag, this creates a new lightweight tag
53- for you, so you could skip the above step).
54- - GUI method: click "Create a new release" on the far right, fill in the tag
55- name (if you didn't tag above, it will be made here), fill in a release
56- name like "Version X.Y.Z", and optionally copy-and-paste the changelog into
57- the description (processed as markdown by Pandoc). Check "pre-release" if
58- this is a beta/RC. You can get partway there with
59- ``cat docs/changelog.rst | pandoc -f rst -t gfm ``.
53+ for you, so you could skip the above step.)
54+
55+ - GUI method: Under `releases <https://github.com/pybind/pybind11/releases >`_
56+ click "Draft a new release" on the far right, fill in the tag name
57+ (if you didn't tag above, it will be made here), fill in a release name
58+ like "Version X.Y.Z", and copy-and-paste the markdown-formatted (!) changelog
59+ into the description (usually ``cat docs/changelog.rst | pandoc -f rst -t gfm ``).
60+ Check "pre-release" if this is a beta/RC.
61+
6062 - CLI method: with ``gh `` installed, run ``gh release create vX.Y.Z -t "Version X.Y.Z" ``
6163 If this is a pre-release, add ``-p ``.
6264
@@ -65,15 +67,15 @@ To release a new version of pybind11:
6567 - Update version macros in ``include/pybind11/detail/common.h `` (set PATCH to
6668 ``0.dev1 `` and increment MINOR).
6769 - Update ``_version.py `` to match
68- - Run ``nox -s tests_packaging` `` to ensure this was done correctly.
70+ - Run ``nox -s tests_packaging `` to ensure this was done correctly.
6971 - Add a spot for in-development updates in ``docs/changelog.rst ``.
7072 - ``git add ``, ``git commit ``, ``git push ``
7173
7274If a version branch is updated, remember to set PATCH to ``1.dev1 ``.
7375
7476If you'd like to bump homebrew, run:
7577
76- .. code-block ::
78+ .. code-block :: console
7779
7880 brew bump-formula-pr --url https://github.com/pybind/pybind11/archive/vX.Y.Z.tar.gz
7981
0 commit comments