Skip to content

Commit 60f8be6

Browse files
committed
docs: Replace older release notes with static copy
Generated with: reno report --branch $branch --stop-at-branch-base --no-show-source where $branch was the respective stable branch. This allows us to tag and delete these old branches. Signed-off-by: Stephen Finucane <stephen@that.guru>
1 parent 4c7d6d8 commit 60f8be6

5 files changed

Lines changed: 1103 additions & 10 deletions

File tree

docs/releases/dazzle.rst

Lines changed: 233 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,236 @@
11
v2.0 Series ("Dazzle")
22
======================
33

4-
.. release-notes::
5-
:branch: stable/2.0
4+
.. _Release Notes_v2.0.3_stable_2.0:
5+
6+
v2.0.3
7+
======
8+
9+
.. _Release Notes_v2.0.3_stable_2.0_Bug Fixes:
10+
11+
Bug Fixes
12+
---------
13+
14+
- If a patch was processed by Patchwork before series support was added, it
15+
will not have a series associated with it. As a result, it is not possible
16+
to extract the dependencies for that patch from the series. This was not
17+
previously handled correctly. A 404 is now raised if this occurs.
18+
19+
- The ``parsemail.sh`` and ``parsemail-batch.sh`` scripts, found in
20+
``patchwork/bin``, will now default to using ``python`` rather than
21+
``python2`` for calling ``manage.py``. This resolves an issue when
22+
Patchwork is deployed with a virtualenv.
23+
24+
25+
.. _Release Notes_v2.0.2_stable_2.0:
26+
27+
v2.0.2
28+
======
29+
30+
.. _Release Notes_v2.0.2_stable_2.0_Bug Fixes:
31+
32+
Bug Fixes
33+
---------
34+
35+
- Resolve some issues caused by parallel parsing of series.
36+
37+
- Poorly formatted email headers are now handled correctly.
38+
39+
- Patches with CRLF newlines are now parsed correctly and these line endings
40+
are stripped when saving patches.
41+
42+
- Resolved some issues with pagination.
43+
44+
- Emails from *git-pull-request* v2.14.3+ are now handled correctly.
45+
46+
- Token generation from the web UI is now disabled if the REST API is
47+
disabled. This was causing an exception.
48+
49+
- Non-breaking spaces in tags are now handled correctly.
50+
51+
- Patches with no space before the series marker, such as ``PATCH1/8``, are
52+
now parsed correctly.
53+
54+
55+
.. _Release Notes_v2.0.1_stable_2.0:
56+
57+
v2.0.1
58+
======
59+
60+
.. _Release Notes_v2.0.1_stable_2.0_Bug Fixes:
61+
62+
Bug Fixes
63+
---------
64+
65+
- Handle requests for pages out of range.
66+
67+
- Fix SQL permissions scripts for tables and columns added in 2.0.
68+
69+
- Fix filtering of projects by name
70+
71+
- Fix "add to bundle" dropdown
72+
73+
- Performance improvements for the XML-RPC API
74+
75+
76+
.. _Release Notes_v2.0.0_stable_2.0:
77+
78+
v2.0.0
79+
======
80+
81+
.. _Release Notes_v2.0.0_stable_2.0_Prelude:
82+
83+
Prelude
84+
-------
85+
86+
The v2.0.0 release includes many new features and bug fixes. For full
87+
information on the options avaiable, you should look at the full release
88+
notes in detail. However, there are two key features that make v2.0.0 a
89+
worthwhile upgrade:
90+
91+
- A REST API is now provided, which will eventually replace the legacy
92+
XML-RPC API
93+
- Patch series and series cover letters are now supported
94+
95+
For further information on these features and the other changes in this
96+
release, review the full release notes.
97+
98+
99+
.. _Release Notes_v2.0.0_stable_2.0_New Features:
100+
101+
New Features
102+
------------
103+
104+
- REST API.
105+
106+
Previous versions of Patchwork provided an XML-RPC API. This was functional
107+
but there were a couple of issues around usability and general design. This
108+
API also provided basic versioning information but the existing clients,
109+
mostly `pwclient` variants, did not validate this version. Together, this
110+
left us with an API that needed work but no way to fix it without breaking
111+
every client out there.
112+
113+
Rather than breaking all those users, make a clean break and provide
114+
another API method. REST APIs are the API method de jour providing a number
115+
of advantages over XML-RPC APIs, thus, a REST API is chosen. The following
116+
resources are exposed over this new API:
117+
118+
- Bundles
119+
- Checks
120+
- Projects
121+
- People
122+
- Users
123+
- Patches
124+
- Series
125+
- Cover letters
126+
127+
For information on the usage of the API, refer to the `documentation
128+
<https://patchwork.readthedocs.io/en/latest/api/rest/>`__.
129+
130+
- Cover letters are now supported.
131+
132+
Cover letters are often sent in addition to a series of patches. They do
133+
not contain a diff and can generally be identified as number 0 of a series.
134+
For example::
135+
136+
[PATCH 0/3] A cover letter
137+
138+
Cover letters contain useful information that should not be discarded.
139+
Both cover letters and replies to these mails are now stored for use with
140+
series.
141+
142+
- Series are now supported.
143+
144+
Series are groups of patches sent as one bundle. For example::
145+
146+
[PATCH 0/3] A cover letter
147+
[PATCH 1/3] The first patch
148+
[PATCH 2/3] The second patch
149+
[PATCH 3/3] The third patch
150+
151+
While Patchwork already supports bundles, these must be created manually,
152+
defeating the purpose of using series in the first place. Series make use
153+
of the information provided in the emails themselves, avoiding this manual
154+
step. The series support implemented is basic and does not support
155+
versioning. This will be added in a future release.
156+
157+
- All comments now have a permalink which can be used to reference individual
158+
replies to patches and cover letters.
159+
160+
- `Django Debug Toolbar <https://pypi.python.org/pypi/django-debug-toolbar>`_
161+
is now enabled by defaut when using development settings.
162+
163+
- `Django 1.9 <https://docs.djangoproject.com/en/1.10/releases/1.9/>`_ and
164+
`1.10 <https://docs.djangoproject.com/en/1.10/releases/1.10/>`_ are now
165+
supported.
166+
167+
- `Python 3.5 <https://www.python.org/downloads/release/python-350/>`_ is now
168+
supported.
169+
170+
- `Docker <https://www.docker.com/what-docker#/developers>`_ support is now
171+
integrated for development usage. To use this, refer to the `documentation
172+
<https://patchwork.readthedocs.io/en/latest/development/installation/>`__.
173+
174+
- Series markers are now parsed from patches generated by the `Mercurial
175+
Patchbomb extension
176+
<https://www.mercurial-scm.org/wiki/PatchbombExtension>`__.
177+
178+
179+
.. _Release Notes_v2.0.0_stable_2.0_Upgrade Notes:
180+
181+
Upgrade Notes
182+
-------------
183+
184+
- The REST API is enabled by default.
185+
186+
The REST API is enabled by default. It is possible to disable this API,
187+
though this functionality may be removed in a future release. Should you
188+
wish to disable this feature, configure the ``ENABLE_REST_API`` setting to
189+
``False``.
190+
191+
- The ``parsemail.py`` and ``parsearchive.py`` scripts have been replaced by
192+
the ``parsemail`` and ``parsearchive`` management commands. These can be
193+
called like any other management commands. For example::
194+
195+
$ ./manage.py parsemail [args...]
196+
197+
- The ``DEFAULT_PATCHES_PER_PAGE`` has been renamed as
198+
``DEFAULT_ITEMS_PER_PAGE`` as it is now possible to list cover letters in
199+
addition to patches.
200+
201+
- The ``context`` field for patch checks must now be slug, or a string
202+
consisting of only ASCII letters, numbers, underscores or hyphens. While
203+
older, non-slugified strings won't cause issues, any scripts creating
204+
contexts must be updated where necessary.
205+
206+
207+
.. _Release Notes_v2.0.0_stable_2.0_Bug Fixes:
208+
209+
Bug Fixes
210+
---------
211+
212+
- When downloading an mbox, a user's name will now be set to the name used in
213+
the last email recieved from them. Previously, the name used in the first
214+
email received from a user was used.
215+
216+
- `user at domain`-style email addresses, commonly found in Mailman archives,
217+
are now handled correctly.
218+
219+
- Unicode characters transmitted over the XML-RPC API are now handled
220+
correctly under Python 3
221+
222+
- The `pwclient` tool will no longer attempt to re-encode unicode to ascii
223+
bytes, which was a frequent cause of ``UnicodeEncodeError`` exceptions.
224+
Instead, a warning is produced if your environement is not configured for
225+
unicode.
226+
227+
228+
.. _Release Notes_v2.0.0_stable_2.0_Other Notes:
229+
230+
Other Notes
231+
-----------
232+
233+
- `reno <https://pypi.python.org/pypi/reno>`_ is now used for release note
234+
management.
235+
236+
- Patch diffs now download with a ``diff`` extension.

0 commit comments

Comments
 (0)