docs: update changelog and add script to help generate it (#2733)

This commit is contained in:
Henry Schreiner 2020-12-21 21:04:33 -05:00 committed by GitHub
parent d5af536fa1
commit 5bd766bf6c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 76 additions and 1 deletions

View File

@ -6,10 +6,35 @@ Changelog
Starting with version 1.8.0, pybind11 releases use a `semantic versioning
<http://semver.org>`_ policy.
v2.6.2 (TBA, not yet released)
------------------------------
* Details to follow here
* Fixed segfault in multithreaded environments when using ``scoped_ostream_redirect``.
`#2675 <https://github.com/pybind/pybind11/pull/2675>`_
* CMake: mixing local and installed pybind11's would prioritize the installed one over the local one (regression in 2.6.0).
`#2716 <https://github.com/pybind/pybind11/pull/2716>`_
* Fix bug where the constructor of `object` subclasses would not throw on being passed a Python object of the wrong type.
`#2701 <https://github.com/pybind/pybind11/pull/2701>`_
* Fixed assertion error related to unhandled (later overwritten) exception in CPython 3.8 and 3.9 debug builds.
`#2685 <https://github.com/pybind/pybind11/pull/2685>`_
* Fix ``py::gil_scoped_acquire`` assert with CPython 3.9 debug build.
`#2683 <https://github.com/pybind/pybind11/pull/2683>`_
* Fixes segfaults in multithreaded environments when using ``scoped_ostream_redirect``.
`#2675 <https://github.com/pybind/pybind11/pull/2675>`_
* Fix issue with FindPython2/FindPython3 not working with ``pybind11::embed``.
`#2662 <https://github.com/pybind/pybind11/pull/2662>`_
* Allow thread termination to be avoided during shutdown for CPython 3.7+ via ``.disarm``.
`#2657 <https://github.com/pybind/pybind11/pull/2657>`_
v2.6.1 (Nov 11, 2020)

50
tools/make_changelog.py Executable file
View File

@ -0,0 +1,50 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
import re
import ghapi.core
ENTRY = re.compile(
r"""
Suggested \s changelog \s entry:
.*
```rst
\s*
(.*?)
\s*
```
""",
re.DOTALL | re.VERBOSE,
)
api = ghapi.core.GhApi(owner="pybind", repo="pybind11")
issues = api.issues.list_for_repo(labels="needs changelog", state="closed")
missing = []
for issue in issues:
changelog = ENTRY.findall(issue.body)
if changelog:
(msg,) = changelog
if not msg.startswith("* "):
msg = "* " + msg
if not msg.endswith("."):
msg += "."
print(msg)
print(f" `#{issue.number} <{issue.html_url}>`_\n")
else:
missing.append(issue)
if missing:
print()
print("-" * 30)
print()
for issue in missing:
print(f"Missing: {issue.title}")
print(f" {issue.html_url}")