mirrors/wagtail
mirrors/wagtail
0
0
Fork 0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 01:46:24 +01:00
Code Issues Releases Wiki Activity
dd31ec54af
wagtail/docs/releases/5.2.md
LB Johnston 1dbf2ec2df Add changelog for #10798
2023-08-31 18:43:15 +10:00

4.8 KiB
Raw Blame History

Wagtail 5.2 release notes - IN DEVELOPMENT

Unreleased

---
local:
depth: 1
---

What's new

Other features

  • Add wagtailcache and wagtailpagecache template tags to ensure previewing Pages or Snippets will not be cached (Jake Howard)
  • Always set help text element ID for form fields with help text in field.html template (Sage Abdullah)
  • Move SnippetViewSet menu registration mechanism to base ViewSet class (Sage Abdullah)
  • Enable reference index tracking for models registered with ModelViewSet (Sage Abdullah)
  • When copying a page or creating an alias, copy its view restrictions to the destination (Sandeep Choudhary, Suyash Singh)
  • Support pickling of StreamField values (pySilver)
  • Move SnippetViewSet template override mechanism to ModelViewSet (Sage Abdullah)
  • Move SnippetViewSet.list_display to ModelViewSet (Sage Abdullah)
  • Remove wagtail.publish log action on aliases when they are created from live source pages or the source page is published (Dan Braghis)
  • Remove wagtail.unpublish log action on aliases when source page is unpublished (Dan Braghis)
  • Add compare buttons to workflow dashboard panel (Matt Westcott)
  • Add the ability to use filters and to export listings in generic IndexView (Sage Abdullah)
  • Move list_filter, filterset_class, search_fields, search_backend_name, list_export, export_filename, list_per_page, and ordering from SnippetViewSet to ModelViewSet (Sage Abdullah)
  • Add default header titles to generic IndexView and CreateView (Sage Abdullah)
  • Allow overriding IndexView.export_headings via ModelViewSet (Christer Jensen, Sage Abdullah)
  • Change spreadsheet export headings to match listing view column headings (Christer Jensen, Sage Abdullah)

Bug fixes

  • Ensure that StreamField's FieldBlocks correctly set the required and aria-describedby attributes (Storm Heg)
  • Avoid an error when the moderation panel (admin dashboard) contains both snippets and private pages (Matt Westcott)
  • When deleting collections, ensure the collection name is correctly shown in the success message (LB (Ben) Johnston)
  • Fix numbers, booleans, and None from being exported as strings (Christer Jensen)
  • Filter out comments on Page editing counts that do not correspond to a valid field / block path on the page such as when a field has been removed (Matt Westcott)

Documentation

  • Document WAGTAILADMIN_BASE_URL on "Integrating Wagtail into a Django project" page (Shreshth Srivastava)
  • Replace incorrect screenshot for authors listing on tutorial (Shreshth Srivastava)

Maintenance

  • Fix snippet search test to work on non-fallback database backends (Matt Westcott)
  • Update Eslint, Prettier & Jest npm packages (LB (Ben) Johnston)
  • Add npm scripts for TypeScript checks and formatting SCSS files (LB (Ben) Johnston)
  • Run tests in parallel in some of the CI setup (Sage Abdullah)
  • Remove unused WorkflowStatus view, urlpattern, and workflow-status.js (Storm Heg)
  • Add support for options/attrs in Telepath widgets so that attrs render on the created DOM (Storm Heg)
  • Update pre-commit hooks to be in sync with latest changes to Eslint & Prettier for client-side changes (Storm Heg)
  • Add WagtailTestUtils.get_soup() method for testing HTML content (Storm Heg, Sage Abdullah)
  • Allow ViewSet subclasses to customise url_prefix and url_namespace logic (Matt Westcott)
  • Simplify SnippetViewSet registration code (Sage Abdullah)
  • Rename groups IndexView.results_template_name to results.html (Sage Abdullah)
  • Migrate form submission listing checkbox toggling to the shared w-bulk Stimulus implementation (LB (Ben) Johnston)

Upgrade considerations - changes affecting all projects

Upgrade considerations - deprecation of old functionality

Upgrade considerations - changes affecting Wagtail customisations

ModelViewSet automatically registers the model to the reference index

Models that are registered with a ModelViewSet now have reference index tracking enabled by default. This means that you no longer need to call ReferenceIndex.register_model() in your app's ready() method for such models. If this is undesired, you can disable it by setting {attr}~wagtail.admin.viewsets.model.ModelViewSet.add_to_reference_index to False on the ModelViewSet subclass. For more details, see .

Groups IndexView.results_template_name renamed from results.html to index_results.html

The IndexView's results_template_name attribute in the GroupViewSet has been renamed from wagtailusers/groups/results.html to wagtailusers/groups/index_results.html for consistency with the other viewsets. If you have customised or extended the template, e.g. for , you will need to rename it to match the new name.