mirrors/wagtail
mirrors/wagtail
0
0
Fork 0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
Code Issues Releases Wiki Activity
276d8e1fcd
wagtail/docs/releases/5.2.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

50 lines
2.1 KiB
Markdown
Raw Normal View History

Set up release notes for 5.2
2023-07-18 18:14:16 +02:00
# Wagtail 5.2 release notes - IN DEVELOPMENT
_Unreleased_
```{contents}
---
local:
depth: 1
---
```
## What's new
### Other features
Create preview-aware & page-enhanced cache template tags This can be used in other places, but ensures caches are invalidated whenever something about a page changes. - Add a util to get wagtail-specific fragment cache keys - Don't pollute context when injecting site variable - Add documentation on wagtail fragment caching - Define an intelligent cache key for pages - Allow the components of the cache key to be easily modified - Note that some manual changes may not create a new cache key Co-authored-by: Andy Babic <andyjbabic@gmail.com> Closes #5074
2022-11-03 18:35:17 +01:00
* Add [`wagtailcache`](wagtailcache) and [`wagtailpagecache`](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
2023-07-12 11:21:59 +02:00
* Always set help text element ID for form fields with help text in `field.html` template (Sage Abdullah)
Set up release notes for 5.2
2023-07-18 18:14:16 +02:00
### Bug fixes
Add support for options/attrs in Telepath widgets & add required/aria-describedby - This allows us to pass extra data for the widget to use in a backwards-compatible way. - FieldBlock: render 'required' and 'aria-describedby' attributes when appropriate - Ensure options passed to `render` override defaults - FieldBlock: add test proving options are constructed and passed down - Allow Telepath's widget rendering to take options - Include extra accessibility-related attributes in html output - Resolves missing required attribute on input elements for required fields - Resolves missing aria-describedby attribute on input element when the field has help text. - Partial work on #10300
2023-07-27 13:37:48 +02:00
* Ensure that StreamField's `FieldBlock`s correctly set the `required` and `aria-describedby` attributes (Storm Heg)
Set up release notes for 5.2
2023-07-18 18:14:16 +02:00
### Documentation
* ...
### Maintenance
Set an AutocompleteField on FullFeaturedSnippet so TestFilterSetClassSearch works correctly
2023-07-18 15:19:09 +02:00
* Fix snippet search test to work on non-fallback database backends (Matt Westcott)
Add changelog for #10682
2023-08-02 13:01:56 +02:00
* Update Eslint, Prettier & Jest npm packages (LB (Ben) Johnston)
Update npm scripts - Add new stylelint fix script & generic 'fix' (all) script in npm scripts. - Disable autofix on `stylelint-declaration-strict-value` as this requires a custom function to be created.
2023-08-02 00:24:26 +02:00
* Add npm scripts for TypeScript checks and formatting SCSS files (LB (Ben) Johnston)
Release notes for #10709
2023-08-02 16:45:14 +02:00
* Run tests in parallel in some of the CI setup (Sage Abdullah)
Remove unused WorkflowStatus view, urlpattern, and workflow-status.js
2023-07-28 11:12:00 +02:00
* Remove unused WorkflowStatus view, urlpattern, and workflow-status.js (Storm Heg)
Add support for options/attrs in Telepath widgets & add required/aria-describedby - This allows us to pass extra data for the widget to use in a backwards-compatible way. - FieldBlock: render 'required' and 'aria-describedby' attributes when appropriate - Ensure options passed to `render` override defaults - FieldBlock: add test proving options are constructed and passed down - Allow Telepath's widget rendering to take options - Include extra accessibility-related attributes in html output - Resolves missing required attribute on input elements for required fields - Resolves missing aria-describedby attribute on input element when the field has help text. - Partial work on #10300
2023-07-27 13:37:48 +02:00
* Add support for options/attrs in Telepath widgets so that attrs render on the created DOM (Storm Heg)
Add changelog for #10742
2023-08-05 02:06:31 +02:00
* 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 to get a `BeautifulSoup` object
2023-07-20 17:32:41 +02:00
* Add `WagtailTestUtils.get_soup()` method to get a `BeautifulSoup` object from an `HttpResponse` object (Storm Heg)
Release note for #10782
2023-08-15 02:33:16 +02:00
* Allow `ViewSet` subclasses to customise `url_prefix` and `url_namespace` logic (Matt Westcott)
Set up release notes for 5.2
2023-07-18 18:14:16 +02:00
Group 5.2 upgrade considerations by impact
2023-08-01 13:32:56 +02:00
## Upgrade considerations - changes affecting all projects
## Upgrade considerations - deprecation of old functionality
## Upgrade considerations - changes affecting Wagtail customisations
Add ModelViewSet.add_to_reference_index to allow opting out of the ReferenceIndex
2023-08-16 12:22:49 +02:00
### `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 [](managing_the_reference_index).
Copy Permalink