Skip to content

Commit d2b4678

Browse files
committed
CHANGES.rst: add release notes for 1.0.0rc1
1 parent 952343e commit d2b4678

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

CHANGES.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,44 @@
22
Release Notes
33
=============
44

5+
.. _Release Notes_1.0.0rc1:
6+
7+
1.0.0rc1
8+
========
9+
10+
.. _Release Notes_1.0.0rc1_New Features:
11+
12+
New Features
13+
------------
14+
15+
- Added a new session scoped fixture ``make_httpserver`` which creates the
16+
object for the ``httpserver`` fixture. It can be overridden to add further
17+
customizations and it must yield a ``HTTPServer`` object - see
18+
``pytest_plugin.py`` for an implementation. As this fixture is session
19+
scoped, it will be called only once when the first test using httpserver is
20+
started. This addition also deprecates the use of ``PluginHTTPServer`` which was
21+
used in earlier versions as a way to customize server object creation.
22+
``PluginHTTPServer`` can still be used but it may be subject to deprecation
23+
in the future.
24+
25+
- Added a new session scoped fixture ``httpserver_ssl_context`` which provides
26+
the SSL context for the server. By default it returns ``None``, so SSL is
27+
not enabled, but can be overridden to return a valid ``ssl.SSLContext``
28+
object which will be used for SSL connections. See test_ssl.py for example.
29+
30+
31+
.. _Release Notes_1.0.0rc1_Upgrade Notes:
32+
33+
Upgrade Notes
34+
-------------
35+
36+
- **Breaking change**: The scope of ``httpserver_listen_address`` fixture changed from **function**
37+
to **session**. This is a requirement to implement the other features listed
38+
in this release. See the `upgrade guide
39+
<https://pytest-httpserver.readthedocs.io/en/latest/upgrade.html>`_ for the
40+
details.
41+
42+
543
.. _Release Notes_0.3.8:
644

745
0.3.8

0 commit comments

Comments
 (0)