@@ -27,7 +27,7 @@ To release a new version of pybind11:
27
27
``include/pybind11/detail/common.h ``. PATCH should be a simple integer.
28
28
- Update the version HEX just below, as well.
29
29
- 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.
31
31
- Ensure that all the information in ``setup.cfg `` is up-to-date, like
32
32
supported Python versions.
33
33
- Add release date in ``docs/changelog.rst ``.
@@ -50,13 +50,15 @@ To release a new version of pybind11:
50
50
- Make a GitHub release (this shows up in the UI, sends new release
51
51
notifications to users watching releases, and also uploads PyPI packages).
52
52
(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
+
60
62
- CLI method: with ``gh `` installed, run ``gh release create vX.Y.Z -t "Version X.Y.Z" ``
61
63
If this is a pre-release, add ``-p ``.
62
64
@@ -65,15 +67,15 @@ To release a new version of pybind11:
65
67
- Update version macros in ``include/pybind11/detail/common.h `` (set PATCH to
66
68
``0.dev1 `` and increment MINOR).
67
69
- 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.
69
71
- Add a spot for in-development updates in ``docs/changelog.rst ``.
70
72
- ``git add ``, ``git commit ``, ``git push ``
71
73
72
74
If a version branch is updated, remember to set PATCH to ``1.dev1 ``.
73
75
74
76
If you'd like to bump homebrew, run:
75
77
76
- .. code-block ::
78
+ .. code-block :: console
77
79
78
80
brew bump-formula-pr --url https://github.com/pybind/pybind11/archive/vX.Y.Z.tar.gz
79
81
0 commit comments