From 79ac41a25196ca554279535cd8148edbbb917162 Mon Sep 17 00:00:00 2001 From: Thibaud Colas Date: Tue, 11 Jun 2024 12:21:13 +0100 Subject: [PATCH] Add mention of html5lib in upgrade considerations (#12031) --- docs/releases/6.1.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/releases/6.1.md b/docs/releases/6.1.md index 59c669ebfb..15cf1beeaf 100644 --- a/docs/releases/6.1.md +++ b/docs/releases/6.1.md @@ -142,7 +142,7 @@ Many thanks to Ben Morse and Joshua Munn for reporting this issue, and Jake Howa ### Maintenance - * Move RichText HTML whitelist parser to use the faster, built in `html.parser` (Jake Howard) + * Move RichText HTML whitelist parser to use the faster, built in `html.parser` rather than `html5lib` (Jake Howard) * Remove duplicate 'path' in default_exclude_fields_in_copy (Ramchandra Shahi Thakuri) * Update unit tests to always use the faster, built in `html.parser` & remove `html5lib` dependency (Jake Howard) * Adjust Eslint rules for TypeScript files (Karthik Ayangar) @@ -199,6 +199,10 @@ See [](frontend_authentication). ## Upgrade considerations - changes to undocumented internals +### Removal of `html5lib` dependency + +Wagtail now uses `html.parser` for its rich text processing, and no longer depends on `html5lib`. If your project relies on `html5lib`, update rich text code to use Wagtail’s documented rich text APIs like [rewrite handlers](rich_text_rewrite_handlers) and [format converters](rich_text_format_converters). Or update project dependencies to include `html5lib`. + ### Deprecation of `user_listing_buttons` template tag The undocumented `user_listing_buttons` template tag has been deprecated and will be removed in a future release.