Skip to content

Commit 08bca37

Browse files
authored
docs: update changelog, nicer output for script (#2811)
1 parent 44105ca commit 08bca37

File tree

2 files changed

+99
-17
lines changed

2 files changed

+99
-17
lines changed

docs/changelog.rst

Lines changed: 79 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,57 @@ v2.6.2 (TBA, not yet released)
1111
------------------------------
1212

1313

14+
Minor missing functionality added:
15+
16+
* enum: add missing Enum.value property.
17+
`#2739 <https://github.com/pybind/pybind11/pull/2739>`_
18+
1419
* Allow thread termination to be avoided during shutdown for CPython 3.7+ via
15-
``.disarm``.
20+
``.disarm`` for ``gil_scoped_acquire``/``gil_scoped_release``.
1621
`#2657 <https://github.com/pybind/pybind11/pull/2657>`_
1722

23+
24+
Build improvements:
25+
26+
* Setup helpers: ``extra_compile_args`` and ``extra_link_args`` automatically set by
27+
Pybind11Extension are now prepended, which allows them to be overridden
28+
by user-set ``extra_compile_args`` and ``extra_link_args``.
29+
`#2808 <https://github.com/pybind/pybind11/pull/2808>`_
30+
31+
* Setup helpers: Don't trigger unused parameter warning.
32+
`#2735 <https://github.com/pybind/pybind11/pull/2735>`_
33+
34+
* CMake: Support running with ``--warn-uninitialized`` active.
35+
`#2806 <https://github.com/pybind/pybind11/pull/2806>`_
36+
37+
* CMake: Avoid error if included from two submodule directories.
38+
`#2804 <https://github.com/pybind/pybind11/pull/2804>`_
39+
40+
* CMake: Fix ``STATIC`` / ``SHARED`` being ignored in FindPython mode.
41+
`#2796 <https://github.com/pybind/pybind11/pull/2796>`_
42+
43+
* CMake: Respect the setting for ``CMAKE_CXX_VISIBILITY_PRESET`` if defined.
44+
`#2793 <https://github.com/pybind/pybind11/pull/2793>`_
45+
46+
* CMake: Fix issue with FindPython2/FindPython3 not working with ``pybind11::embed``.
47+
`#2662 <https://github.com/pybind/pybind11/pull/2662>`_
48+
49+
* CMake: mixing local and installed pybind11's would prioritize the installed
50+
one over the local one (regression in 2.6.0).
51+
`#2716 <https://github.com/pybind/pybind11/pull/2716>`_
52+
53+
54+
Bug fixes:
55+
56+
* Fix invalid access when calling a pybind11 ``__init__`` on a non-pybind11
57+
class instance.
58+
`#2755 <https://github.com/pybind/pybind11/pull/2755>`_
59+
60+
* The ``type_caster`` for integers does not convert Python objects with
61+
``__int__`` anymore with ``noconvert`` or during the first round of trying
62+
overloads.
63+
`#2698 <https://github.com/pybind/pybind11/pull/2698>`_
64+
1865
* Fix bug where the constructor of ``object`` subclasses would not throw on
1966
being passed a Python object of the wrong type.
2067
`#2701 <https://github.com/pybind/pybind11/pull/2701>`_
@@ -34,18 +81,40 @@ v2.6.2 (TBA, not yet released)
3481
* Fix ``py::gil_scoped_acquire`` assert with CPython 3.9 debug build.
3582
`#2683 <https://github.com/pybind/pybind11/pull/2683>`_
3683

37-
* CMake: Fix issue with FindPython2/FindPython3 not working with ``pybind11::embed``.
38-
`#2662 <https://github.com/pybind/pybind11/pull/2662>`_
84+
* Fix issue with a test failing on PyTest 6.2.
85+
`#2741 <https://github.com/pybind/pybind11/pull/2741>`_
3986

40-
* CMake: mixing local and installed pybind11's would prioritize the installed
41-
one over the local one (regression in 2.6.0).
42-
`#2716 <https://github.com/pybind/pybind11/pull/2716>`_
87+
Warning fixes:
4388

44-
* Don't trigger unused parameter warning in ``setup_helpers.py``.
45-
`#2735 <https://github.com/pybind/pybind11/pull/2735>`_
89+
* Fix warning modifying constructor parameter 'flag' that shadows a field of
90+
'set_flag' ``[-Wshadow-field-in-constructor-modified]``.
91+
`#2780 <https://github.com/pybind/pybind11/pull/2780>`_
4692

47-
* Fix issue with a test failing on PyTest 6.2.
48-
`#2741 <https://github.com/pybind/pybind11/pull/2741>`_
93+
* Suppressed some deprecation warnings about old-style
94+
``__init__``/``__setstate__`` in the tests.
95+
`#2759 <https://github.com/pybind/pybind11/pull/2759>`_
96+
97+
Valgrind work:
98+
99+
* Fixed various minor memory leaks in pybind11's test suite.
100+
`#2758 <https://github.com/pybind/pybind11/pull/2758>`_
101+
102+
* Resolved memory leak in cpp_function initialization when exceptions occurred.
103+
`#2756 <https://github.com/pybind/pybind11/pull/2756>`_
104+
105+
* Added a Valgrind build, checking for leaks and memory-related UB, to CI.
106+
`#2746 <https://github.com/pybind/pybind11/pull/2746>`_
107+
108+
Compiler support:
109+
110+
* Intel compiler was not activating C++14 support due to a broken define.
111+
`#2679 <https://github.com/pybind/pybind11/pull/2679>`_
112+
113+
* Support ICC and NVIDIA HPC SDK in C++17 mode.
114+
`#2729 <https://github.com/pybind/pybind11/pull/2729>`_
115+
116+
* Support Intel OneAPI compiler (ICC 20.2) and add to CI.
117+
`#2573 <https://github.com/pybind/pybind11/pull/2573>`_
49118

50119

51120

tools/make_changelog.py

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33

44
import re
55

6-
import ghapi.core
6+
import ghapi.all
7+
8+
from rich import print
9+
from rich.syntax import Syntax
710

811

912
ENTRY = re.compile(
@@ -19,8 +22,10 @@
1922
re.DOTALL | re.VERBOSE,
2023
)
2124

25+
print()
26+
2227

23-
api = ghapi.core.GhApi(owner="pybind", repo="pybind11")
28+
api = ghapi.all.GhApi(owner="pybind", repo="pybind11")
2429

2530
issues = api.issues.list_for_repo(labels="needs changelog", state="closed")
2631
missing = []
@@ -34,17 +39,25 @@
3439
if not msg.endswith("."):
3540
msg += "."
3641

37-
print(msg)
38-
print(f" `#{issue.number} <{issue.html_url}>`_\n")
42+
msg += f"\n `#{issue.number} <{issue.html_url}>`_"
43+
44+
print(Syntax(msg, "rst", theme="ansi_light"))
45+
print()
3946

4047
else:
4148
missing.append(issue)
4249

4350
if missing:
4451
print()
45-
print("-" * 30)
52+
print("[blue]" + "-" * 30)
4653
print()
4754

4855
for issue in missing:
49-
print(f"Missing: {issue.title}")
50-
print(f" {issue.html_url}")
56+
print(f"[red bold]Missing:[/red bold][red] {issue.title}")
57+
print(f"[red] {issue.html_url}\n")
58+
59+
print("[bold]Template:\n")
60+
msg = "## Suggested changelog entry:\n\n```rst\n\n```"
61+
print(Syntax(msg, "md", theme="ansi_light"))
62+
63+
print()

0 commit comments

Comments
 (0)