Skip to content

Commit aa8ed7b

Browse files
Generate a change log entry for v11.0.0rc0
1 parent 3591a1c commit aa8ed7b

27 files changed

+183
-96
lines changed

CHANGES.rst

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,189 @@ Changelog
1414

1515
.. towncrier release notes start
1616
17+
v11.0.0rc0
18+
==========
19+
20+
*(2024-04-16)*
21+
22+
23+
Bug fixes
24+
---------
25+
26+
- Fixed a flaw where internally unhandled exceptions
27+
could crash the worker threads and eventually starve
28+
the server of its processing resources. It is no
29+
longer and issue and the unhandled errors are now
30+
logged and suppressed except for a few expected
31+
exceptions that are used for normal interruption
32+
requests.
33+
34+
-- by :user:`cameronbrunner` and :user:`webknjaz`
35+
36+
*Related issues and pull requests on GitHub:*
37+
:issue:`310`, :issue:`346`, :issue:`354`, :issue:`358`, :issue:`365`, :issue:`375`, :issue:`599`, :issue:`641`, :issue:`649`.
38+
39+
- Fixed compatibility with Python 3.8 in the built-in
40+
TLS adapter that relies on :py:mod:`python:ssl`.
41+
42+
Modern Python versions communicate specialized exceptions
43+
:py:exc:`ssl.SSLEOFError` and :py:exc:`ssl.SSLZeroReturnError`
44+
where the older versions errored out in a very generic way.
45+
46+
-- by :user:`toppk` and :user:`webknjaz`
47+
48+
*Related issues and pull requests on GitHub:*
49+
:issue:`517`, :issue:`518`.
50+
51+
52+
Removals and backward incompatible breaking changes
53+
---------------------------------------------------
54+
55+
- Cheroot dropped support for Python 3.6 and 3.7.
56+
It now requires Python 3.8 or later.
57+
58+
-- by :user:`jaraco`
59+
60+
*Related issues and pull requests on GitHub:*
61+
:issue:`565`, :issue:`633`.
62+
63+
64+
Packaging updates and notes for downstreams
65+
-------------------------------------------
66+
67+
- Started signing the package distribution artifacts in CI/CD
68+
with Sigstore and uploading them to GitHub Releases
69+
-- by :user:`webknjaz`.
70+
71+
*Related commits on GitHub:*
72+
:commit:`27a3c944`, :commit:`c45f184e`.
73+
74+
- The minimum version of the ``setuptools-scm`` build dependency
75+
has been set to 7. The Git archives are now produced by it
76+
natively, instead of relying on a third party plugin which is
77+
no longer being used.
78+
79+
-- by :user:`serhii73`
80+
81+
*Related issues and pull requests on GitHub:*
82+
:issue:`628`.
83+
84+
- The changelog management is now implemented through
85+
the :std:doc:`Towncrier <towncrier:index>` tool
86+
-- by :user:`webknjaz`.
87+
88+
The contributors are now expected to :std:ref:`include
89+
change log fragment files in their pull requests
90+
<adding change notes with your prs>`.
91+
92+
These news snippets can link one or more issues or pull
93+
requests, and be of one or more of the following categories:
94+
95+
* ``bugfix``: A bug fix for something we deemed an improper undesired
96+
behavior that got corrected in the release to match pre-agreed
97+
expectations.
98+
* ``feature``: A new behavior, public APIs. That sort of stuff.
99+
* ``deprecation``: A declaration of future API removals and breaking
100+
changes in behavior.
101+
* ``breaking``: When something public gets removed in a breaking way.
102+
Could be deprecated in an earlier release.
103+
* ``doc``: Notable updates to the documentation structure or build
104+
process.
105+
* ``packaging``: Notes for downstreams about unobvious side effects
106+
and tooling. Changes in the test invocation considerations and
107+
runtime assumptions.
108+
* ``contrib``: Stuff that affects the contributor experience. e.g.
109+
Running tests, building the docs, setting up the development
110+
environment.
111+
* ``misc``: Changes that are hard to assign to any of the above
112+
categories.
113+
114+
*Related issues and pull requests on GitHub:*
115+
:issue:`654`.
116+
117+
118+
Contributor-facing changes
119+
--------------------------
120+
121+
- Started type-checking the project with MyPy against a
122+
range of versions instead of just one — Python 3.8–3.12
123+
-- by :user:`webknjaz`.
124+
125+
*Related commits on GitHub:*
126+
:commit:`4fa1e663`, :commit:`676edc4e`, :commit:`be9dbc41`.
127+
128+
- The project how has a :file:`.git-blame-ignore-revs` letting
129+
GitHub know which auto-formatting revisions to ignore. It is
130+
also possible to integrate it locally, if one wants to do so.
131+
132+
-- by :user:`webknjaz`
133+
134+
*Related commits on GitHub:*
135+
:commit:`5980a3fb`, :commit:`f8a1cc4d`.
136+
137+
- The project adopted the ``autopep8`` tool to assist with
138+
automatic code formatting. It is chosen over ``black``
139+
because it is less intrusive which is important to the
140+
maintainer as it promotes inclusivity.
141+
``autopep8`` is integrated into the ``pre-commit`` check
142+
runner and is configured to only correct :pep:`8`
143+
violations, avoiding changes to compliant snippets.
144+
145+
-- by :user:`webknjaz`
146+
147+
*Related commits on GitHub:*
148+
:commit:`65ba7e69`.
149+
150+
- The continuous integration and pull request merges have been
151+
set up to only merge pull requests through merge queues
152+
-- by :user:`webknjaz`.
153+
154+
*Related commits on GitHub:*
155+
:commit:`a7149e0c`.
156+
157+
- Documented the upgraded :std:doc:`release process
158+
<contributing/release_guide>` -- by :user:`webknjaz`.
159+
160+
*Related commits on GitHub:*
161+
:commit:`df0d1a08`.
162+
163+
- The changelog management is now implemented through
164+
the :std:doc:`Towncrier <towncrier:index>` tool
165+
-- by :user:`webknjaz`.
166+
167+
The contributors are now expected to :std:ref:`include
168+
change log fragment files in their pull requests
169+
<adding change notes with your prs>`.
170+
171+
These news snippets can link one or more issues or pull
172+
requests, and be of one or more of the following categories:
173+
174+
* ``bugfix``: A bug fix for something we deemed an improper undesired
175+
behavior that got corrected in the release to match pre-agreed
176+
expectations.
177+
* ``feature``: A new behavior, public APIs. That sort of stuff.
178+
* ``deprecation``: A declaration of future API removals and breaking
179+
changes in behavior.
180+
* ``breaking``: When something public gets removed in a breaking way.
181+
Could be deprecated in an earlier release.
182+
* ``doc``: Notable updates to the documentation structure or build
183+
process.
184+
* ``packaging``: Notes for downstreams about unobvious side effects
185+
and tooling. Changes in the test invocation considerations and
186+
runtime assumptions.
187+
* ``contrib``: Stuff that affects the contributor experience. e.g.
188+
Running tests, building the docs, setting up the development
189+
environment.
190+
* ``misc``: Changes that are hard to assign to any of the above
191+
categories.
192+
193+
*Related issues and pull requests on GitHub:*
194+
:issue:`654`.
195+
196+
197+
----
198+
199+
17200
v10.0.0
18201
=======
19202

docs/changelog-fragments.d/27a3c944.packaging.rst

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/changelog-fragments.d/310.bugfix.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/changelog-fragments.d/346.bugfix.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/changelog-fragments.d/354.bugfix.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/changelog-fragments.d/358.bugfix.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/changelog-fragments.d/365.bugfix.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/changelog-fragments.d/375.bugfix.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/changelog-fragments.d/4fa1e663.contrib.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/changelog-fragments.d/517.bugfix.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)