Skip to content

Commit 1391e71

Browse files
Generate a change log entry for v10.0.1
1 parent c00f21b commit 1391e71

24 files changed

+161
-85
lines changed

CHANGES.rst

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

1515
.. towncrier release notes start
1616
17+
v10.0.1
18+
=======
19+
20+
*(2024-04-22)*
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+
Packaging updates and notes for downstreams
53+
-------------------------------------------
54+
55+
- Started signing the package distribution artifacts in CI/CD
56+
with Sigstore and uploading them to GitHub Releases
57+
-- by :user:`webknjaz`.
58+
59+
*Related commits on GitHub:*
60+
:commit:`27a3c944`, :commit:`c45f184e`.
61+
62+
- The changelog management is now implemented through
63+
the :std:doc:`Towncrier <towncrier:index>` tool
64+
-- by :user:`webknjaz`.
65+
66+
The contributors are now expected to :std:ref:`include
67+
change log fragment files in their pull requests
68+
<adding change notes with your prs>`.
69+
70+
These news snippets can link one or more issues or pull
71+
requests, and be of one or more of the following categories:
72+
73+
* ``bugfix``: A bug fix for something we deemed an improper undesired
74+
behavior that got corrected in the release to match pre-agreed
75+
expectations.
76+
* ``feature``: A new behavior, public APIs. That sort of stuff.
77+
* ``deprecation``: A declaration of future API removals and breaking
78+
changes in behavior.
79+
* ``breaking``: When something public gets removed in a breaking way.
80+
Could be deprecated in an earlier release.
81+
* ``doc``: Notable updates to the documentation structure or build
82+
process.
83+
* ``packaging``: Notes for downstreams about unobvious side effects
84+
and tooling. Changes in the test invocation considerations and
85+
runtime assumptions.
86+
* ``contrib``: Stuff that affects the contributor experience. e.g.
87+
Running tests, building the docs, setting up the development
88+
environment.
89+
* ``misc``: Changes that are hard to assign to any of the above
90+
categories.
91+
92+
*Related issues and pull requests on GitHub:*
93+
:issue:`654`.
94+
95+
96+
Contributor-facing changes
97+
--------------------------
98+
99+
- Started type-checking the project with MyPy against a
100+
range of versions instead of just one — Python 3.8–3.12
101+
-- by :user:`webknjaz`.
102+
103+
*Related commits on GitHub:*
104+
:commit:`4fa1e663`, :commit:`676edc4e`, :commit:`be9dbc41`.
105+
106+
- The project how has a :file:`.git-blame-ignore-revs` letting
107+
GitHub know which auto-formatting revisions to ignore. It is
108+
also possible to integrate it locally, if one wants to do so.
109+
110+
-- by :user:`webknjaz`
111+
112+
*Related commits on GitHub:*
113+
:commit:`5980a3fb`, :commit:`f8a1cc4d`.
114+
115+
- The project adopted the ``autopep8`` tool to assist with
116+
automatic code formatting. It is chosen over ``black``
117+
because it is less intrusive which is important to the
118+
maintainer as it promotes inclusivity.
119+
``autopep8`` is integrated into the ``pre-commit`` check
120+
runner and is configured to only correct :pep:`8`
121+
violations, avoiding changes to compliant snippets.
122+
123+
-- by :user:`webknjaz`
124+
125+
*Related commits on GitHub:*
126+
:commit:`65ba7e69`.
127+
128+
- The continuous integration and pull request merges have been
129+
set up to only merge pull requests through merge queues
130+
-- by :user:`webknjaz`.
131+
132+
*Related commits on GitHub:*
133+
:commit:`a7149e0c`.
134+
135+
- Documented the upgraded :std:doc:`release process
136+
<contributing/release_guide>` -- by :user:`webknjaz`.
137+
138+
*Related commits on GitHub:*
139+
:commit:`df0d1a08`.
140+
141+
- The changelog management is now implemented through
142+
the :std:doc:`Towncrier <towncrier:index>` tool
143+
-- by :user:`webknjaz`.
144+
145+
The contributors are now expected to :std:ref:`include
146+
change log fragment files in their pull requests
147+
<adding change notes with your prs>`.
148+
149+
These news snippets can link one or more issues or pull
150+
requests, and be of one or more of the following categories:
151+
152+
* ``bugfix``: A bug fix for something we deemed an improper undesired
153+
behavior that got corrected in the release to match pre-agreed
154+
expectations.
155+
* ``feature``: A new behavior, public APIs. That sort of stuff.
156+
* ``deprecation``: A declaration of future API removals and breaking
157+
changes in behavior.
158+
* ``breaking``: When something public gets removed in a breaking way.
159+
Could be deprecated in an earlier release.
160+
* ``doc``: Notable updates to the documentation structure or build
161+
process.
162+
* ``packaging``: Notes for downstreams about unobvious side effects
163+
and tooling. Changes in the test invocation considerations and
164+
runtime assumptions.
165+
* ``contrib``: Stuff that affects the contributor experience. e.g.
166+
Running tests, building the docs, setting up the development
167+
environment.
168+
* ``misc``: Changes that are hard to assign to any of the above
169+
categories.
170+
171+
*Related issues and pull requests on GitHub:*
172+
:issue:`654`.
173+
174+
175+
----
176+
177+
17178
v10.0.0
18179
=======
19180

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)