You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add command to check for vX.Y.Z tag vs pybind11/_version.py consistency. (#4757)
* Add command to check for vX.Y.Z tag vs pybind11/_version.py consistency. Piggy-backing hints for converting changelog to release message.
* Simpler way of double-checking version number in sources vs. git tag
* Even simpler.
* Fix rst rendering (hopefully) and remove stray dots.
* [ci skip] Trying more to make GitHub rst renderer show this nicely.
* [ci skip] Fix up RST rendering issues.
Lesson learned:
This is NOT GOOD:
```
- Bullet nesting level 1.
- Bullet nesting level 2.
```
This is BETTER:
```
- Bullet nesting level 1.
- Bullet nesting level 2.
```
Also consistently adding empty lines between bullet points, to make the .rst
file easier to read.
Also piggy-backing a few very minor enhancements.
- Update tags (optional; if you skip this, the GitHub release makes a
48
-
non-annotated tag for you)
49
-
- ``git tag -a vX.Y.Z -m 'vX.Y.Z release'``.
50
-
- ``git push --tags``.
62
+
non-annotated tag for you)
63
+
64
+
- ``git tag -a vX.Y.Z -m 'vX.Y.Z release'``
65
+
66
+
- ``grep ^__version__ pybind11/_version.py``
67
+
68
+
- Last-minute consistency check: same as tag?
69
+
70
+
- ``git push --tags``
71
+
51
72
- Update stable
52
-
- ``git checkout stable``
53
-
- ``git merge -X theirs vX.Y.Z``
54
-
- ``git diff vX.Y.Z``
55
-
- Carefully review and reconcile any diffs. There should be none.
56
-
- ``git push``
73
+
74
+
- ``git checkout stable``
75
+
76
+
- ``git merge -X theirs vX.Y.Z``
77
+
78
+
- ``git diff vX.Y.Z``
79
+
80
+
- Carefully review and reconcile any diffs. There should be none.
81
+
82
+
- ``git push``
83
+
57
84
- Make a GitHub release (this shows up in the UI, sends new release
58
85
notifications to users watching releases, and also uploads PyPI packages).
59
86
(Note: if you do not use an existing tag, this creates a new lightweight tag
60
87
for you, so you could skip the above step.)
61
-
- GUI method: Under `releases <https://github.com/pybind/pybind11/releases>`_
62
-
click "Draft a new release" on the far right, fill in the tag name
63
-
(if you didn't tag above, it will be made here), fill in a release name
64
-
like "Version X.Y.Z", and copy-and-paste the markdown-formatted (!) changelog
65
-
into the description (usually ``cat docs/changelog.rst | pandoc -f rst -t gfm``).
66
-
Check "pre-release" if this is a beta/RC.
67
-
- CLI method: with ``gh`` installed, run ``gh release create vX.Y.Z -t "Version X.Y.Z"``
68
-
If this is a pre-release, add ``-p``.
88
+
89
+
- GUI method: Under `releases <https://github.com/pybind/pybind11/releases>`_
90
+
click "Draft a new release" on the far right, fill in the tag name
91
+
(if you didn't tag above, it will be made here), fill in a release name
92
+
like "Version X.Y.Z", and copy-and-paste the markdown-formatted (!) changelog
93
+
into the description. You can use ``cat docs/changelog.rst | pandoc -f rst -t gfm``,
94
+
then manually remove line breaks and strip links to PRs and issues,
95
+
e.g. to a bare ``#1234``, without the surrounding ``<...>_`` hyperlink markup.
96
+
Check "pre-release" if this is a beta/RC.
97
+
98
+
- CLI method: with ``gh`` installed, run ``gh release create vX.Y.Z -t "Version X.Y.Z"``
99
+
If this is a pre-release, add ``-p``.
69
100
70
101
- Get back to work
71
-
- Make sure you are on master, not somewhere else: ``git checkout master``
72
-
- Update version macros in ``include/pybind11/detail/common.h`` (set PATCH to
73
-
``0.dev1`` and increment MINOR).
74
-
- Update ``pybind11/_version.py`` to match
75
-
- Run ``nox -s tests_packaging`` to ensure this was done correctly.
76
-
- If the release was a new MINOR version, add a new `IN DEVELOPMENT`
77
-
section in ``docs/changelog.rst``.
78
-
- ``git add``, ``git commit``, ``git push``
102
+
103
+
- Make sure you are on master, not somewhere else: ``git checkout master``
104
+
105
+
- Update version macros in ``include/pybind11/detail/common.h`` (set PATCH to
106
+
``0.dev1`` and increment MINOR).
107
+
108
+
- Update ``pybind11/_version.py`` to match.
109
+
110
+
- Run ``nox -s tests_packaging`` to ensure this was done correctly.
111
+
112
+
- If the release was a new MINOR version, add a new ``IN DEVELOPMENT``
113
+
section in ``docs/changelog.rst``.
114
+
115
+
- ``git add``, ``git commit``, ``git push``
79
116
80
117
If a version branch is updated, remember to set PATCH to ``1.dev1``.
81
118
@@ -92,7 +129,11 @@ merge it if there are no issues.
92
129
Manual packaging
93
130
^^^^^^^^^^^^^^^^
94
131
95
-
If you need to manually upload releases, you can download the releases from the job artifacts and upload them with twine. You can also make the files locally (not recommended in general, as your local directory is more likely to be "dirty" and SDists love picking up random unrelated/hidden files); this is the procedure:
132
+
If you need to manually upload releases, you can download the releases from
133
+
the job artifacts and upload them with twine. You can also make the files
134
+
locally (not recommended in general, as your local directory is more likely
135
+
to be "dirty" and SDists love picking up random unrelated/hidden files);
0 commit comments